ShippingOption

A Shipping Option represents a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.

Properties

admin_onlybooleanRequired

Flag to indicate if the Shipping Option usage is restricted to admin users.

Default: false

amountnull | numberRequired

The amount to charge for shipping when the Shipping Option price type is flat\_rate.

created_atDateRequired

The date with timezone at which the resource was created.

dataRecord<string, unknown>Required

The data needed for the Fulfillment Provider to identify the Shipping Option.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

idstringRequired

The shipping option's ID

includes_taxbooleanRequired

Whether the shipping option price include tax

Default: false

is_returnbooleanRequired

Flag to indicate if the Shipping Option can be used for Return shipments.

Default: false

metadataRecord<string, unknown>Required

An optional key-value map with additional details

namestringRequired

The name given to the Shipping Option - this may be displayed to the Customer.

price_typeShippingOptionPriceTypeRequired

The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be flat\_rate for fixed prices or calculated if the Fulfillment Provider can provide price calulations.

profileShippingProfileRequired

The details of the shipping profile that the shipping option belongs to.

profile_idstringRequired

The ID of the Shipping Profile that the shipping option belongs to.

providerFulfillmentProviderRequired

The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.

provider_idstringRequired

The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.

regionRegionRequired

The details of the region this shipping option can be used in.

region_idstringRequired

The ID of the region this shipping option can be used in.

requirementsShippingOptionRequirement[]Required

The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.

updated_atDateRequired

The date with timezone at which the resource was updated.