List Shiptheory Shipments
GET/api/shiptheory/:integration_instance/shipments
Paginated, filterable list of Shiptheory shipments (booked consignments) for the integration instance. Each row carries the booked-side data (carrier, service, tracking, carrier cost, parcel count, booked_at) plus cross-links to the parent Shiptheory order and the sales order fulfillment the shipment realized. One consignment carries one tracking number even when it spans multiple parcels.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
filter[search] does a fuzzy partial match across id, tracking_number, carrier_name, service_name and the parent order reference.
Every filter[<column>] also accepts an operator suffix as filter[<column>.<operator>]=<value>; a bare filter[<column>]=<value> means "is".
- Text operators supported: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty.
- Numeric operators supported: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty.
- Date/datetime operators supported: is, is_not, before, after, on_or_before, on_or_after, between, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days, is_empty, is_not_empty.
filter[linked_to_sku]=true returns only shipments linked to a SKU.io sales order fulfillment; false returns only unlinked shipments.
Sort with the sort parameter (prefix - for descending). Allowed sort fields: id, shiptheory_order_id, carrier_name, service_name, tracking_number, shipping_cost, number_of_parcels, booked_at, created_at, updated_at. Default sort is -id. Results are paginated; per_page defaults to 10.
Authentication: requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.