Download Packing Instructions¶

Download the generated Packing Instructions (PI) file for a completed order.

Note

PI is typically ready within a few minutes after order creation. Poll this endpoint or wait before fetching; the order must be fully processed first.

Endpoint¶

GET {base url}/api/v1/orders/download-packing-instructions/?order={reference}

Authentication Requirements¶

Requires a valid API key. See API Authentication.

Query Parameters¶

Parameter	Type	Description
`order`	String	Required. The shipment reference or Alpha ID associated with the order. Cannot be blank.

Success Response (200 OK)¶

Returns the PI file as a downloadable attachment (e.g. PDF). If the order is still processing, you may receive 400 or an error — retry after a short delay.

Error Responses¶

400 Bad Request — Order not found:

                                            {
  "order": [
    "No order found matching the provided reference."
  ]
}

                                        

This is returned when no order matching the provided order value exists within the API key’s company group. Orders belonging to other groups are invisible and also produce this response.

400 Bad Request — PI not ready yet:

                                            {
  "order": [
    "Packing instructions not available yet, please try after couple of minutes. If not ready within 10 minutes, reach out to our support team"
  ]
}

                                        

The order was found but does not yet have a generated PI file. This can happen when optimization is still in progress. Retry after a short delay.

403 Forbidden — Invalid or missing API key.