Shipments
Request label
Requests the shipment label, as pdf or zpl, in a job.
POST/v1/shipments/{shipmentId}/label-requests
Coming soon
This route is not in the API yet. This page shows what it will do. Fields, examples and the playground arrive when it ships.
Send the format (pdf or zpl). It answers 202 with a shipment.label job. When the label is ready, shipment.label_ready arrives with the assetId, and you download the file in Download asset content. It is confidential: it never has a public URL.
Refusals, all before the job: 422 if the format is not supported; 409 if the shipment is not ready_to_ship (shipment_not_ready) or the invoice blocks the shipment (invoice_required). See Send invoice.