List Inbound Shipments

Required permission: read_inbound_shipments

Get a list of inbound shipments for your organization or client.

Parcels added through the Inbound tracking panel are returned in tracked_packages.
The legacy tracking_number and tracking_url fields remain independent and may be empty.
updated_at advances when a parcel is added, edited, or removed, or its tracking status,
latest event, or estimated delivery date changes. Polling without new tracking information
does not advance the shipment timestamp. After adopting tracked_packages, perform one
full sync to import parcels added before this behavior was introduced.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Specifies the field by which to sort the returned inbound shipments:

  • created_at: Sort by the creation date of the inbound shipment.
  • updated_at: Sort by the last updated date of the inbound shipment.
  • reference_number: Sort by the reference number (PO number) of the inbound shipment.
Allowed:
integer
1 to 100
Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

integer
≥ 0
Defaults to 0
deprecated

Deprecated. Use cursor instead. Offset pagination will be removed on November 9, 2026. See Pagination.

The number of items to skip before starting to return results. Cannot be used together with the cursor parameter.

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

string
enum
Defaults to asc

Specifies the sort direction of the returned items:

  • asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
  • desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.
Allowed:
string

A value to search for within the items. The specific fields searched depend on the endpoint.

integer
≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json