Skip to content

Latest commit

 

History

History
25 lines (24 loc) · 2.22 KB

File metadata and controls

25 lines (24 loc) · 2.22 KB

ShippingMethod

Properties

Name Type Description Notes
id String The shipping method's ID
shippingOptionId String The id of the Shipping Option that the Shipping Method is built from.
orderId String The id of the Order that the Shipping Method is used on.
order Object An order object. Available if the relation `order` is expanded. [optional]
claimOrderId String The id of the Claim that the Shipping Method is used on.
claimOrder Object A claim order object. Available if the relation `claim_order` is expanded. [optional]
cartId String The id of the Cart that the Shipping Method is used on.
cart Object A cart object. Available if the relation `cart` is expanded. [optional]
swapId String The id of the Swap that the Shipping Method is used on.
swap Object A swap object. Available if the relation `swap` is expanded. [optional]
returnId String The id of the Return that the Shipping Method is used on.
returnOrder Object A return object. Available if the relation `return_order` is expanded. [optional]
shippingOption ShippingOption [optional]
taxLines List<ShippingMethodTaxLine> Available if the relation `tax_lines` is expanded. [optional]
price Integer 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.
data Object 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.
includesTax Boolean [EXPERIMENTAL] Indicates if the shipping method price include tax [optional]
subtotal Integer The subtotal of the shipping [optional]
total Integer The total amount of the shipping [optional]
taxTotal Integer The total of tax [optional]