AdminGetShippingOptionsParams
Parameters used to filter the retrieved shipping options.
Properties
id
string | string[]IDs to filter shipping options by.
name
stringName to filter shipping options by.
region_id
stringFilter by a region ID.
is_return
booleanFilter by whether the shipping option is used for returns or orders.
admin_only
booleanFilter by whether the shipping options are available for admin users only.
q
stringFilter shipping options by a search query.
order
stringThe 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_at
DateComparisonOperatorDate filters to apply on shipping options' created_at
field.
created_at
DateComparisonOperatorcreated_at
field.updated_at
DateComparisonOperatorDate filters to apply on shipping options' updated_at
field.
updated_at
DateComparisonOperatorupdated_at
field.deleted_at
DateComparisonOperatorDate filters to apply on shipping options' deleted_at
field.
deleted_at
DateComparisonOperatordeleted_at
field.fields
stringComma-separated fields that should be included in the returned shipping options.
expand
stringComma-separated relations that should be expanded in the returned shipping options.
offset
numberThe number of items to skip when retrieving a list.
Default: 0
limit
numberLimit the number of items returned in the list.
Default: 20
Was this section helpful?