List Shipments

This endpoint returns a paginated list of shipments that match the specified search criteria.

You can use the search_string parameter to search for shipments alongside other filter, sort, and pagination options.

Note: This endpoint has a monthly usage limit tied to your account's shipment quota. Once the monthly limit is exceeded, further requests to this endpoint will be blocked.

SecurityOAuth2
Request
query Parameters
search_string
string

The search string to find shipments using shipment data such as carrier tracking number, order reference, shipment reference, customer name, email etc.

order_ref
string

The string to be used to fetch shipments for a given order reference.

merchant
string

The merchant parameter filters shipments for a given merchant. This parameter can be used multiple times to filter results for multiple merchants.

shipment_type
string

The shipment type can either be forward or reverse. If not passed, then both types of shipments will be included in the results.

creation_date_from
string

The start date is ISO 8601 format to filter the results.

creation_date_to
string

The end date is ISO 8601 format to filter the results.

page
string

The page number of the result set, starting from 0. Defaults to the first page (page 0).

page_size
string

The number of results to be included in the response, ranging from 10 to 100. Defaults to page size of 10.

header Parameters
x-api-key
required
string
tenant-id
required
string
Responses
200
get/shipments
Request samples 
Response samples 
application/json
[
  • {
    }
]