List all shipping methods

How to fetch a collection of shipping methods via API

To fetch a collection of shipping methods, send a GET request to the /api/shipping_methods endpoint.

Request

GET https://yourdomain.commercelayer.io/api/shipping_methods

Example

Request

The following request fetches a collection of shipping methods:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/shipping_methods/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of shipping methods can be sorted by the following fields:

Attributes

• name

• scheme

• currency_code

• price_amount_cents

• free_over_amount_cents

• id

• disabled_at

• circuit_state

• circuit_failure_count

• created_at

• updated_at

• reference

• reference_origin

Relationships

• market

• shipping_zone

• shipping_category

• stock_location

Filterable fields

The list of shipping methods can be filtered by the following fields:

Attributes

• name

• scheme

• currency_code

• price_amount_cents

• free_over_amount_cents

• id

• disabled_at

• circuit_state

• circuit_failure_count

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• market

• shipping_zone

• shipping_category

• stock_location

• shipping_method_tiers

• attachments

• notifications