Skip to main content

List Shiptheory Delivery Services

GET 

/api/shiptheory/:integration_instance/delivery-services

Paginated, filterable list of the Shiptheory delivery services synced for the instance, each with its optional mapping to a SKU shipping method. An unmapped service (sku_shipping_method_id = null) is a valid default — Shiptheory's rules engine picks the carrier at booking.

Required scope: integrations:read

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

filter[search] does a fuzzy partial match across name, carrier_name and the mapped shipping method name.

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.

Sort with the sort parameter (prefix - for descending). Allowed sort fields: id, service_id, name, carrier_name, enabled, created_at, updated_at. Default sort is carrier_name. Results are paginated; per_page defaults to 10.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type