ShippingMethod
A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.
Properties
id
stringRequiredThe shipping method's ID
shipping_option_id
stringRequiredThe ID of the Shipping Option that the Shipping Method is built from.
order_id
stringRequiredThe ID of the order that the shipping method is used in.
The details of the order that the shipping method is used in.
claim_order_id
null | stringRequiredThe ID of the claim that the shipping method is used in.
The details of the claim that the shipping method is used in.
cart_id
stringRequiredThe ID of the cart that the shipping method is used in.
The details of the cart that the shipping method is used in.
swap_id
stringRequiredThe ID of the swap that the shipping method is used in.
The details of the swap that the shipping method is used in.
return_id
stringRequiredThe ID of the return that the shipping method is used in.
The details of the return that the shipping method is used in.
The details of the shipping option the method was created from.
The details of the tax lines applied on the shipping method.
price
numberRequiredThe amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.
data
Record<string, unknown>RequiredAdditional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.
includes_tax
booleanRequiredWhether the shipping method price include tax
Default: false
subtotal
numberThe subtotal of the shipping
total
numberThe total amount of the shipping
tax_total
numberThe total of tax
Was this section helpful?