FilterableShippingOptionForContextProps

A context's details used to filter the shipping option.

$and(FilterableShippingOptionProps | BaseFilterable<FilterableShippingOptionProps>)[]

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.

$or(FilterableShippingOptionProps | BaseFilterable<FilterableShippingOptionProps>)[]

An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.

idstring | string[] | OperatorMap<string | string[]>

The IDs to filter the shipping options by.

namestring | string[] | OperatorMap<string | string[]>

Filter the shipping options by their name.

shipping_profile_idstring | string[] | OperatorMap<string | string[]>

Filter the shipping options by the ID of their associated shipping profile.

price_typeShippingOptionPriceType | ShippingOptionPriceType[] | OperatorMap<ShippingOptionPriceType | ShippingOptionPriceType[]>

Filter the shipping options by their price type.

service_zoneFilterableServiceZoneProps

The filters to apply on the retrieved service zones.

shipping_option_typeFilterableShippingOptionTypeProps

The filters to apply on the retrieved shipping option types.

rulesFilterableShippingOptionRuleProps

The filters to apply on the retrieved shipping option rules.

fulfillment_set_idstring | string[] | OperatorMap<string | string[]>

The fulfillment set's ID used in the context.

fulfillment_set_typestring | string[] | OperatorMap<string | string[]>

The fulfillment set's type used in the context.

addressobject

The address used in the context. It filters the shipping options based on the geo zones of their associated service zone.

address.country_codestring

The ISO 2 character country code.

address.province_codestring

The province code.

address.citystring

The city.

address.postal_expressionstring

The postal expression

contextRecord<string, any>

The shipping option's context to filter directly.