API Reference

Retrieve a list of shipping methods for your organization or client. This endpoint supports pagination, sorting, and search functionality.

Log in to see full request history
Query Params
string

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.
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.

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

The number of items to skip before starting to return results. Used for pagination.

string
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.
string

A value to search for within the items. The specific fields searched depend on the endpoint.

Responses

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