CalculatedDraftOrder

Required access

read_draft_orders access scope

The computed properties for a draft order.

Show definition
# The computed properties for a draft order.
type CalculatedDraftOrder {
  # Order-level discount applied to the draft order.
  appliedDiscount: DraftOrderAppliedDiscount

  # The available shipping rates for the draft order. Requires a customer with a
  # valid shipping address and at least one line item.
  availableShippingRates: [ShippingRate!]!

  # Customer who will be sent an invoice for the draft order, if there is one.
  customer: Customer

  # Line items in the draft order with their computed properties.
  lineItems: [CalculatedDraftOrderLineItem!]!

  # Line item that contains the shipping costs.
  shippingLine: ShippingLine

  # Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes).
  subtotalPrice: Money!

  # Total amount of taxes charged for each line item and shipping line.
  taxLines: [TaxLine!]!

  # Total amount of the draft order (includes taxes, shipping charges, and discounts).
  totalPrice: Money!

  # Total shipping charge for the draft order.
  totalShippingPrice: Money!

  # Total amount of taxes for the draft order.
  totalTax: Money!
}

Fields

appliedDiscount   (DraftOrderAppliedDiscount)

Order-level discount applied to the draft order.

Required access

read_ access scope

availableShippingRates   ([ShippingRate!]!)

The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item.

Required access

read_ access scope

customer   (Customer)

Customer who will be sent an invoice for the draft order, if there is one.

Required access

read_ access scope

lineItems   ([CalculatedDraftOrderLineItem!]!)

Line items in the draft order with their computed properties.

Required access

read_ access scope

shippingLine   (ShippingLine)

Line item that contains the shipping costs.

Required access

read_ access scope

subtotalPrice   (Money!)

Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes).

Required access

read_ access scope

taxLines   ([TaxLine!]!)

Total amount of taxes charged for each line item and shipping line.

Required access

read_ access scope

totalPrice   (Money!)

Total amount of the draft order (includes taxes, shipping charges, and discounts).

Required access

read_ access scope

totalShippingPrice   (Money!)

Total shipping charge for the draft order.

Required access

read_ access scope

totalTax   (Money!)

Total amount of taxes for the draft order.

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up