Courier Details

The Courier Details API retrieves courier information for a specific order, including the courier name, courier code, AWB numbers, and any additional information related to the shipment.

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

Try out Fynd Konnect's Courier Details Endpoint

Common Request Header

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

Important Considerations

Fetches courier details of upto 20 orders in a single API call.
For orders with unserviceable pincodes (for certain delivery partners), Fynd must continue attempting different couriers until an available delivery partner is found. It is recommended to poll orders using the endpoint at increasing intervals until a delivery partner is assigned and the shipping label is generated.

Body

orderIdstringrequired

Unique identifier for the order for which the courier details need to be fetched

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/courierDetails \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Response

application/json

[
  {
    "courierName": "FyndTest",
    "courierCode": "FyndTest",
    "awbNumber": [ … ],
    "additionalInfo": "You can add additional info here",
    "orderId": "17788083923861469968"
  },
  {
    "courierName": "FyndTest",
    "courierCode": "FyndTest",
    "awbNumber": [ … ],
    "additionalInfo": "You can add additional info here",
    "orderId": "17888083923861469000"
  }
]

Error Codes

Reason	Code	Description
Invalid `orderId`	C400	If `orderId` does not belong to the requested location
Invalid request	C403	If courier details are requested before `dp_assigned` stage

Next Steps

Once order is packed, the customer invoice can be fetched, see Customer Invoice endpoint
Pre-dispatch, the shipping label can be fetched from Fynd using Shipping Label endpoint