Docs
Dashboard

OrderShippingLine

Object

Represents a shipping line applied to an order.

#

Fields


id
ID!

The unique identifier of the order shipping line.

shippingMethod
ShippingMethod

The shipping method associated with this shipping line. If the shipping method has been deleted, this will be null. Use the shippingMethodId, shippingMethodName, and shippingMethodSku fields to access the original shipping method details.

shippingMethodId
ID!

The unique identifier of the shipping method associated with this shipping line.

shippingMethodName
String!

The name of the shipping method associated with this shipping line.

shippingMethodSku
String

The SKU of the shipping method associated with this shipping line.

subtotal
Money!

The subtotal for the shipping line before discounts and tax.

taxBehavior
TaxBehavior!

The tax behavior applied when calculating this shipping line.

Possible enum values
  • EXCLUSIVE

    Exclusive tax is added on top of the price. For example, a product has the price defined as 5.00 USD. The tax charged on this product could be 10% and would result in a final price of 5.50 USD. (Tax rates might differ—this is only an explanatory example.)

  • INCLUSIVE

    Inclusive tax is already included in the price. For example, a product has the price defined as 5.00 USD. The final price the customer pays is 5.00 USD.

taxRate
TaxRate

The tax rate used for this shipping line, if available.

taxedPrice
TaxedPrice

The taxed prices (net, gross, tax) for this shipping line, if calculated.

total
Money!

The total amount charged for the shipping line after adjustments.