API ReferenceDocs
API Reference
Dashboard
These docs are for v2023.01. Click to read the latest docs for v2024.09.

Get a Shipment

get
https://api.easyship.com/2023-01/shipments/

Retrieve details of a specific shipment.

Required authorization scope: Shipment

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Easyship Shipment ID provided when creating the shipment

Query Params
string

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.

string

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

string

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

string

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

Responses

Updated 11 months ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago