Sign in

v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Shipments

Get a Shipment

Retrieve details of a specific shipment.

Required authorization scope: public.shipment:read

All shipment documents are customisable. You can set:

  • Document format: URL, PDF or PNG
  • Label page size: A4, A5 or 4x6
  • Commercial invoice page size: A4 or 4x6
  • Packing slip page size: A4 or 4x6
get/2024-09/shipments/{easyship_shipment_id}

Path parameters

easyship_shipment_idstring required

Easyship Shipment ID provided when creating the shipment

Query parameters

formatstring

Document format (Options: URL, PDF, PNG). URL will be a link to a .pdf file, PNG and PDF will be an array of base64 encoded strings.

labelstring

Label page size (Options: A4, A5, 4x6). Some couriers only offer A4 labels.

commercial_invoicestring

Commercial invoice page size (Options: A4, 4x6). An invoice will only be provided if necessary. Some couriers offer a paperless invoice service.

packing_slipstring

Packing slip page size (Options: none, A4, 4x6).

Response

shipment