AdminShippingOptionListParams

Properties#

fieldsstringOptional

The fields and relations to retrieve separated by commas. Learn more in the API reference.

limitnumberOptional

The maximum number of items to retrieve.

offsetnumberOptional

The number of items to skip before retrieving the returned items.

orderstringOptional

The field to sort by and in which order.

idstring | string[]Optional

Filter by shipping option ID(s),

qstringOptional

Query or keywords to search the shipping option's searchable fields.

service_zone_idstring | string[]Optional

Filter by the ID of the service zone(s) to retrieve the shipping options for.

stock_location_idstring | string[]Optional

Filter by the ID of the stock location(s) to retrieve the shipping options for.

is_returnbooleanOptional

Filter by whether the shipping option is a return shipping option.

admin_onlybooleanOptional

Filter by whether the shipping option is only available to admins.

shipping_profile_idstring | string[]Optional

Filter by the ID of the shipping profile(s) to retrieve the shipping options for.

provider_idstring | string[]Optional

Filter by the ID of the provider(s) to retrieve the shipping options for.

shipping_option_type_idstring | string[]Optional

Filter by the ID of the shipping option type(s) to retrieve the shipping options for.

created_atOperatorMap<string>Optional

Filter by the date the shipping option was created.

updated_atOperatorMap<string>Optional

Filter by the date the shipping option was updated.

deleted_atOperatorMap<string>Optional

Filter by the date the shipping option was deleted.