AdminPostShippingOptionsReq
The details of the shipping option to create.
Properties
name
stringRequiredThe name of the Shipping Option
region_id
stringRequiredThe ID of the Region in which the Shipping Option will be available.
provider_id
stringRequiredThe ID of the Fulfillment Provider that handles the Shipping Option.
data
Record<string, unknown>RequiredThe data needed for the Fulfillment Provider to handle shipping with this Shipping Option.
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.
flat\_rate
indicates fixed pricing, whereas calculated
indicates that the price will be calculated each time by the fulfillment provider.profile_id
stringThe ID of the Shipping Profile to add the Shipping Option to.
amount
numberThe amount to charge for the Shipping Option. If the
price\_type
is set to calculated
, this amount will not actually be used.requirements
OptionRequirement[]The requirements that must be satisfied for the Shipping Option to be available.
requirements
OptionRequirement[]admin_only
booleanIf set to
true
, the shipping option can only be used when creating draft orders.Default: false
is_return
booleanWhether the Shipping Option can be used for returns or during checkout.
Default: false
metadata
Record<string, unknown>An optional set of key-value pairs with additional information.
includes_tax
booleanTax included in prices of shipping option
Was this section helpful?