Order Dispatch

The Order Dispatch API updates the status of specified orders to dispatched state, indicating they have been handed over to the delivery partner. If a dispatched event is raised for a canceled shipment, the system will generate an objection.

Request Type: POST
Scheme: HTTPS
Endpoint: https://{{host}}/oms/v3/shipment/dispatch

Try out Fynd Konnect's Order Dispatch Endpoint

Common Request Header

Header	Mandatory	Description
`x-access-token`	Yes	The token required for authenticated calls to Fynd Konnect.

Important Considerations

Up to 20 order dispatch calls can be sent to Fynd in a single API call

Body

orderIdstringrequired

Unique identifier for the order for which the order dispatch call needs to be pushed to Fynd

Success Response

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

API Call Example

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/dispatch \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string",
      "orderItems": [
        {
          "orderItemId": "string",
          "quantity": 0
        }
      ]
    }
  ]'

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Error Codes

Reason	Code	Description
Cancelled by customer/seller	D401	If `orderId` is cancelled
Invalid `orderId`	D422	If `orderId` does not belong to the requested location
Invalid request	D400	If dispatch request is raised when the current status is not `packed`

Next Steps

Post-dispatch, for channel shipping, merchants can get milestone updates from the Fynd Seller Portal. Partners can fetch in-transit and delivered orders; see Fetch Orders
For self-ship orders, post-dispatch, update Fynd once the order is handed over to the customer using the Update Shipment Status endpoint