AdminGetShippingOptionsParams

Parameters used to filter the retrieved shipping options.

Properties

idstring | string[]

IDs to filter shipping options by.

namestring

Name to filter shipping options by.

region_idstring

Filter by a region ID.

is_returnboolean

Filter by whether the shipping option is used for returns or orders.

admin_onlyboolean

Filter by whether the shipping options are available for admin users only.

qstring

Filter shipping options by a search query.

orderstring

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

created_atDateComparisonOperator

Date filters to apply on shipping options' created_at field.

updated_atDateComparisonOperator

Date filters to apply on shipping options' updated_at field.

deleted_atDateComparisonOperator

Date filters to apply on shipping options' deleted_at field.

fieldsstring

Comma-separated fields that should be included in the returned shipping options.

expandstring

Comma-separated relations that should be expanded in the returned shipping options.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 20