AdminPostShippingOptionsReq

The details of the shipping option to create.

Properties

namestringRequired

The name of the Shipping Option

region_idstringRequired

The ID of the Region in which the Shipping Option will be available.

provider_idstringRequired

The ID of the Fulfillment Provider that handles the Shipping Option.

dataRecord<string, unknown>Required

The data needed for the Fulfillment Provider to handle shipping with this Shipping Option.

price_typeShippingOptionPriceTypeRequired

The type of the Shipping Option price. flat\_rate indicates fixed pricing, whereas calculated indicates that the price will be calculated each time by the fulfillment provider.

profile_idstring

The ID of the Shipping Profile to add the Shipping Option to.

amountnumber

The amount to charge for the Shipping Option. If the price\_type is set to calculated, this amount will not actually be used.

requirementsOptionRequirement[]

The requirements that must be satisfied for the Shipping Option to be available.

admin_onlyboolean

If set to true, the shipping option can only be used when creating draft orders.

Default: false

is_returnboolean

Whether the Shipping Option can be used for returns or during checkout.

Default: false

metadataRecord<string, unknown>

An optional set of key-value pairs with additional information.

includes_taxboolean

Tax included in prices of shipping option