Get Shipment Info
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

The Get Shipment Info API provides a lightweight method to retrieve essential order information without fetching the complete order payload. This endpoint is optimized for quick status checks, delivering crucial details such as order status, order type, SLA deadlines, lock status, and processing due times. It is ideal for monitoring order queues, checking fulfillment readiness, and implementing efficient polling mechanisms.

Use this API when you need fast access to order metadata without the overhead of parsing full order details, making it perfect for dashboard views, status monitoring systems, and pre-processing validation checks.

Request Type: GET
Scheme: HTTPS
Endpoint: https://{{host}}/oms/v3/shipment/info

Try out Fynd Konnect's Get Shipment Info Endpoint

Common Request Headers

Header	Mandatory	Description
`x-access-token`	Yes	Access token used for authenticating API requests to Fynd Konnect
`Content-Type`	Yes	`application/json`

Best Practices

Use for status polling: Ideal for frequent status checks without full payload overhead
Check lock status first: Verify lockStatus before attempting order modifications to avoid conflicts
Monitor SLA deadlines: Use sla field to prioritize order processing and prevent TAT breaches
Filter by orderStatus: Retrieve shipments in specific states for targeted processing workflows
Validate before operations: Check shipment info before calling pack, invoice, or dispatch APIs

Query Parameters

orderIdstring

Unique shipment identifier to retrieve specific order information

orderStatusstring

Filter shipments by current status (e.g., CREATED, CONFIRMED, PROCESSING, DELIVERED)

Parameter Requirements

Either orderId OR orderStatus is mandatory. You must provide at least one parameter:

Use orderId to get info for a specific shipment
Use orderStatus to retrieve all shipments in a particular state

Success Response

ordersArray of objects

List of order information objects matching the query

API Call Example

curl -i -X GET \
  'https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/info?orderId=string&orderStatus=string' \
  -H 'x-access-token: YOUR_API_KEY_HERE'

Example Response

Retrieve lightweight info for all shipments in a specific status:

  {
    "orders": [
      {
        "id": "17614789115571370742",
        "marketplaceOrderId": "FY68FE08FF517FA67468",
        "orderStatus": "CREATED",
        "order_type": "HomeDelivery",
        "is_self_ship": false,
        "orderDate": "2025-10-26T17:11:52+00:00",
        "sla": "2025-10-28T17:15:11.946627+05:30",
        "paymentType": "COD",
        "lockStatus": false,
        "lock_data": {
          "locked": false,
          "mto": false,
          "lock_message": ""
        },
        "processingDueTime": null,
        "orderItems": null
      }
    ]
  }