List shipments.
Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.
Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').
The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.
Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.
The maximum number of items to return per page. Used for both offset and cursor-based pagination.
Returns an array of shipment summaries with tracking information and status.
The unique identifier for the bookedshipment
The unique identifier for the seller
The unique identifier for the shippingservice
Tracking information or tracking enabled status
Tracking information or tracking enabled status
Tracking information or tracking enabled status
Tracking information or tracking enabled status
The unique identifier for the shipmententifier
Reference number or identifier for the item
The direction value
Country code or name
ZIP or postal code
Company name
The name of the ship to
The name of the ship to
Carrier identifier or information
Country code or name
ZIP or postal code
Company name
The name of the ship from
The name of the ship from
Boolean flag indicating pii data removed
The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment.
The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment.
Length of the shipment in meters.
Width of the shipment in meters.
Height of the shipment in meters.
Amount value
Currency information
The
Indicates whether tracking is enabled
The unique identifier for the userentifier
The shipment date date
The name of the warehouse
Timestamp when the item was created
The cancelled at timestamp
Array of document items
Array of export position