Shipping Label

The Shipping Label API generates and fetches a shipping label in .pdf format for a specified order. This label is available in both A4 and A6 sizes, suitable for printing and shipping purposes.

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

Try out Fynd Konnect's Shipping Label Endpoint

Common Request Header

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

Important Considerations

Support shipping label fetch for upto 20 orders in a single call

Body

orderIdstringrequired

Unique identifier for the order for which the shipping label 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/labels \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Response

application/pdf

As a response, the shipping label PDF will be the output.

Error Codes

Reason	Code	Description
Invalid `orderId`	L400	If `orderId` does not belong to the requested location
Invalid request	L403	If label request is raised before the order is packed

Next Steps

Pre-dispatch, the customer invoice can be fetched using Customer Invoice endpoint
Once an order has been dispatched from the warehouse, a dispatch call needs to be made to Fynd; see Order Dispatch