Get Shipments

Retrieve an existing shipment using the shipment key (ShipmentID) or Reference. The response will contain the tracking number and required docs for the shipment.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

CustomerKey

string

optional

CustomerKey

Reference

string

optional

Reference to get details

ShipmentID

string

optional

ShipmentID to get details

isReturn

boolean

optional

Set true to get the return shipment

Example:

false

Responses

🟢200Get Shipments Response

application/json

Body

array of:

ShipmentID

string

required

The unique id for the shipment that can be used to retrieve it later

Status

string

required

Status

Reference

string

required

The reference id that was sent in the request

Message

string

optional

Message

TrackingNumber

string

required

Tracking number for the shipment

TrackingUrl

string

optional

The url to fetch the live tracking status of the shipment

ConsolidateLabel

string

optional

The url to fetch the generated consolidated label

LabelUrl

array[string]

required

Carrier

string

required

Carrier

CustomsInvoiceURL

string

required

The url to fetch the generated consolidated label

SubmittedElectronically

boolean

optional

SubmittedElectronically

Example

[
  {
    "ShipmentID": "string",
    "Status": "string",
    "Reference": "string",
    "Message": "string",
    "TrackingNumber": "string",
    "TrackingUrl": "string",
    "ConsolidateLabel": "string",
    "LabelUrl": [
      "string"
    ],
    "Carrier": "string",
    "CustomsInvoiceURL": "string",
    "SubmittedElectronically": true
  }
]

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Request

Request samples

Responses