List Shipping Methods

Required permission: read_shipping_methods

Get a list of shipping methods for your organization or client.

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 shipping methods:

  • created_at: Sort by the creation date of the shipping method.
  • name: Sort by the name of the shipping method.
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.

integer
≥ 1

Filters shipping methods by the specified store_id. Must be a valid store ID belonging to your organization or client.

Responses

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