List Shipping Options

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

The number of items to skip when retrieving a list.

limit

number

Limit the number of items returned in the list.

order

string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

id

Filter by a shipping option ID.

q

string

Search term to filter the shipping option's searchable properties.

service_zone_id

Filter by a service zone's ID to retrieve its associated shipping options.

shipping_profile_id

Filter by a shipping profile's ID to retrieve its associated shipping options.

provider_id

Filter by a fulfillment provider's ID to retrieve its associated shipping options.

shipping_option_type_id

Filter by a shipping option type's ID to retrieve its associated shipping options.

created_at

object

Filter by a shipping option's creation date.

Show child attributes

created_at.$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

created_at.$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

created_at.$eq

Filter by an exact match.

created_at.$ne

string

Filter by values not equal to this parameter.

created_at.$in

string[]

Filter by values in this array.

created_at.$nin

string[]

Filter by values not in this array.

created_at.$not

Filter by values not matching the conditions in this parameter.

created_at.$gt

string

Filter by values greater than this parameter. Useful for numbers and dates only.

created_at.$gte

string

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

created_at.$lt

string

Filter by values less than this parameter. Useful for numbers and dates only.

created_at.$lte

string

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

created_at.$like

string

Apply a like filter. Useful for strings only.

created_at.$re

string

Apply a regex filter. Useful for strings only.

created_at.$ilike

string

Apply a case-insensitive like filter. Useful for strings only.

created_at.$fulltext

string

Filter to apply on full-text properties.

created_at.$overlap

string[]

Filter arrays that have overlapping values with this parameter.

created_at.$contains

string[]

Filter arrays that contain some of the values of this parameter.

created_at.$contained

string[]

Filter arrays that contain all values of this parameter.

created_at.$exists

boolean

Filter by whether a value for this parameter exists (not null).

updated_at

object

Filter by a shipping option's update date.

Show child attributes

updated_at.$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

updated_at.$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

updated_at.$eq

Filter by an exact match.

updated_at.$ne

string

Filter by values not equal to this parameter.

updated_at.$in

string[]

Filter by values in this array.

updated_at.$nin

string[]

Filter by values not in this array.

updated_at.$not

Filter by values not matching the conditions in this parameter.

updated_at.$gt

string

Filter by values greater than this parameter. Useful for numbers and dates only.

updated_at.$gte

string

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

updated_at.$lt

string

Filter by values less than this parameter. Useful for numbers and dates only.

updated_at.$lte

string

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

updated_at.$like

string

Apply a like filter. Useful for strings only.

updated_at.$re

string

Apply a regex filter. Useful for strings only.

updated_at.$ilike

string

Apply a case-insensitive like filter. Useful for strings only.

updated_at.$fulltext

string

Filter to apply on full-text properties.

updated_at.$overlap

string[]

Filter arrays that have overlapping values with this parameter.

updated_at.$contains

string[]

Filter arrays that contain some of the values of this parameter.

updated_at.$contained

string[]

Filter arrays that contain all values of this parameter.

updated_at.$exists

boolean

Filter by whether a value for this parameter exists (not null).

deleted_at

object

Filter by a shipping option's deletion date.

Show child attributes

deleted_at.$and

$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

deleted_at.$or

$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

deleted_at.$eq

Filter by an exact match.

deleted_at.$ne

string

Filter by values not equal to this parameter.

deleted_at.$in

string[]

Filter by values in this array.

deleted_at.$nin

string[]

Filter by values not in this array.

deleted_at.$not

Filter by values not matching the conditions in this parameter.

deleted_at.$gt

string

Filter by values greater than this parameter. Useful for numbers and dates only.

deleted_at.$gte

string

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

deleted_at.$lt

string

Filter by values less than this parameter. Useful for numbers and dates only.

deleted_at.$lte

string

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

deleted_at.$like

string

Apply a like filter. Useful for strings only.

deleted_at.$re

string

Apply a regex filter. Useful for strings only.

deleted_at.$ilike

string

Apply a case-insensitive like filter. Useful for strings only.

deleted_at.$fulltext

string

Filter to apply on full-text properties.

deleted_at.$overlap

string[]

Filter arrays that have overlapping values with this parameter.

deleted_at.$contains

string[]

Filter arrays that contain some of the values of this parameter.

deleted_at.$contained

string[]

Filter arrays that contain all values of this parameter.

deleted_at.$exists

boolean

Filter by whether a value for this parameter exists (not null).

stock_location_id

Filter by a location ID to retrieve its associated shipping option.

is_return

boolean

Filter by whether the shipping option is used for returns.

admin_only

boolean

Filter by whether the shipping option is used by admin users only.

with_deleted

boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of shipping options. The paginated list of shipping options.

limit

number

required

The maximum number of items returned.

offset

number

required

The number of items skipped before retrieving the returned items.

count

number

required

The total number of items.

shipping_options

object[]

required

The list of shipping options.

Overview

Scanner API

Admin API

Authorizations

Query Parameters

Response