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

idstringRequired

The shipping method's ID

shipping_option_idstringRequired

The ID of the Shipping Option that the Shipping Method is built from.

order_idstringRequired

The ID of the order that the shipping method is used in.

orderOrderRequired

The details of the order that the shipping method is used in.

claim_order_idnull | stringRequired

The ID of the claim that the shipping method is used in.

claim_orderClaimOrderRequired

The details of the claim that the shipping method is used in.

cart_idstringRequired

The ID of the cart that the shipping method is used in.

cartCartRequired

The details of the cart that the shipping method is used in.

swap_idstringRequired

The ID of the swap that the shipping method is used in.

swapSwapRequired

The details of the swap that the shipping method is used in.

return_idstringRequired

The ID of the return that the shipping method is used in.

return_orderReturnRequired

The details of the return that the shipping method is used in.

shipping_optionShippingOptionRequired

The details of the shipping option the method was created from.

tax_linesShippingMethodTaxLine[]Required

The details of the tax lines applied on the shipping method.

pricenumberRequired

The 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.

dataRecord<string, unknown>Required

Additional 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_taxbooleanRequired

Whether the shipping method price include tax

Default: false

subtotalnumber

The subtotal of the shipping

totalnumber

The total amount of the shipping

tax_totalnumber

The total of tax