Skip to main content

List Shiptheory Orders

GET 

/api/shiptheory/:integration_instance/orders

Paginated, filterable list of Shiptheory orders for the integration instance. Each row carries the provider identifiers (reference, status, tracking_number), carrier and delivery fields, price/cost, a deep link to the Shiptheory portal (external_url), and cross-link fields to the originating fulfillment order and its parent sales order.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

filter[search] does a fuzzy partial match across reference, reference2, carrier_name, tracking_number, recipient_name and delivery_postcode.

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 orders linked to a SKU.io fulfillment order; false returns only unlinked orders.

Provider statuses are case-sensitive — equality operators on filter[status] match exactly.

Sort with the sort parameter (prefix - for descending). Allowed sort fields: id, reference, reference2, status, carrier_name, tracking_number, recipient_name, delivery_postcode, value, weight, parcels, shipping_price, shipment_cost, details_last_updated, created_at, updated_at. Default sort is -id (newest first). Results are paginated; per_page defaults to 10.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type