Sign in
Shipments

List shipments

Returns a list of your shipments. The shipments are returned sorted by creation date, with the most recent shipments appearing first.

This api will return all shipments associated with the account. Shipments created via the tracking_request API aswell as the ones added via the dashboard will be retuned via this endpoint.

get/shipments

Query parameters

page[number]integer
page[size]integer
qstring

Search shipments by master bill of lading, reference number, or container number.

includestring

Comma delimited list of relations to include

numberstring

Search shipments by the original request tracking request_number

filter[tracking_stopped]boolean

Filter shipments by whether they are still tracking or not

Response

OK

Example response

{
  "included": [
    {
      "attributes": {
        "fees_at_pod_terminal": [
          {
            "currency_code": "USD"
          }
        ]
      }
    }
  ]
}

Changes