Retrieve shipments
This endpoint allows you to retrieve a list of all the shipments which you have created or imported into your Sendcloud account under your API credentials. You can filter the results based on several query parameters.
This endpoint uses cursor-based pagination via Link headers. See Pagination for details.
Query parameters
Returns shipments that have the requested status. For a list of possible statuses, see the Retrieve a list of parcel statuses endpoint.
Returns shipments that match a specified tracking number
Returns shipments that match a specified external reference
Returns a shipment that matches a specific order_number property from your shipments
Returns all shipments that matches a specific integration_id property from your shipments
Returns all shipments which have been updated in our system before a given time. Use the ISO 8601 datetime format.
Returns all shipments which have been updated in our system after a given time. Use the ISO 8601 datetime format.
Returns all shipments which have been announced to the carrier before the given time. Use the ISO 8601 datetime format.
Returns all shipments which have been announced to the carrier after the given time. Use the ISO 8601 datetime format.
Filter results using a comma-separated list of parcels IDs. The list may not contain more than 100 IDs.
Filter results using a comma-separated list of shipments IDs. The list may not contain more than 100 IDs.
The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.
There are 3 possible parameters to encode:
- o: Offset
- r: Reverse
- p: Position
For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.
The maximum number of items to be returned in the response.
Response
OK