API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

CalculatedDraftOrder object

Version unstable

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2021-04 (Release candidate)

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2021-01 (Latest)

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2020-10

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2020-07

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2020-04

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2020-01 (Unsupported)

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2019-10 (Unsupported)

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2019-07 (Unsupported)

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.

Version 2019-04 (Unsupported)

The computed properties for a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Order-level discount applied to the draft order.

  • availableShippingRates ([ShippingRate!]!)

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

  • customer (Customer)

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

  • lineItems ([CalculatedDraftOrderLineItem!]!)

    Line items in the draft order with their computed properties.

  • shippingLine (ShippingLine)

    Line item that contains the shipping costs.

  • subtotalPrice (Money!)

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

  • taxLines ([TaxLine!]!)

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

  • totalPrice (Money!)

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

  • totalShippingPrice (Money!)

    Total shipping charge for the draft order.

  • totalTax (Money!)

    Total amount of taxes for the draft order.