Skip to main content

List Shipping Methods

GET 
/api/v2/shipping-methods

Returns a paginated list of the shipping methods configured on the account, each with its carrier, delivery window and tracking-link availability.

Authentication: Requires Bearer token.

Filters

  • filter[search] — matches id (exact), method name, full name, type, or carrier name
  • filter[shipping_carrier_id] — exact carrier id
  • filter[has_tracking] — true returns only methods whose carrier has a tracking link, false only those without
  • filter[archived] — omit for active only, only for archived only, all for both

Sorts — sort accepts id, name, method_name, full_name, min_business_days, max_business_days, type, created_at, updated_at. Prefix with - for descending. Default: -id.

Pagination — page and per_page (default 10). Pass per_page=-1 to return every method on a single page.

is_rate_shop marks a method that carries no service instruction: when an order using it is sent to a fulfillment provider, no carrier or service is named and the provider selects the carrier itself (rate shop).

Required scope: settings:read

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

Request​

Responses​

OK