[GET] Download packing instructions#

Downloads the packing instructions file after optimization completes. Prefer Event types instead of polling.

GET https://BASE_URL/api/v1/orders/download-packing-instructions/

Note

In the examples, BASE_URL is the base URL of your environment, for example https://api.alphaaugmented.com. See Base URLs for the complete list.

Requires Authentication.

Parameters#

Parameter	Type	Description
`order`	string	Required. Your `reference` or `alpha_ref`. If several orders share a reference, the newest match is used.

Request#

                                            curl "https://BASE_URL/api/v1/orders/download-packing-instructions/?order=YOUR_REF" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -o packing_instructions.pdf

                                        

Response#

200 OK returns the packing instructions file directly in the response body, not JSON. The format is PDF or Excel depending on lane configuration; you cannot choose it with a query parameter.

Example successful response:

                                            HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="ALPHA-ABC123_packing_instructions.pdf"

<binary PDF or Excel bytes>

Typical Content-Type values:

Content-Type	Meaning
`application/pdf`	PDF packing instructions
`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`	Excel (`.xlsx`) packing instructions

Save the body to a file (for example with curl -o). Use Content-Disposition when you need the suggested filename.

Warning

Do not parse a successful 200 body as JSON.

Errors#

Failed requests return JSON.

HTTP status	Description
`400 Bad Request`	No matching order, or packing instructions not ready yet
`401 Unauthorized`	Missing or invalid API key

Note

Orders outside your API key scope return the same 400 as an unknown reference.

400 Not found

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

                                                

400 Not ready

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

                                                

401

                                                    { "detail": "Invalid API key." }

                                                

See Troubleshooting if requests fail unexpectedly.