DraftOrderShippingOption

Object

A configured shipping method and applicable rate eligible for a draft order.

Fields

centAmount Long!: The applicable shipping price in minor currency units.
currencyCode String!: The ISO 4217 currency code for the shipping price.
description String: The optional shipping method description.
id ID!: The shipping method identifier.
name String!: The customer-facing shipping method name.
rateId ID!: The applicable shipping rate identifier.
sku String: The optional shipping method SKU.
taxBehavior TaxBehavior!: Whether the shipping price includes or excludes tax.
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.

draftOrderShippingOptions: Previews the configured shipping methods whose zones, predicates, currency, and rates are eligible for an unsaved draft order. Shipping lines in the supplied configuration are ignored.