CalculatedDraftOrder

object

Requires read_draft_orders access scope.

The calculated fields for a draft order.

Anchor to FieldsFields

Anchor to acceptAutomaticDiscountsacceptAutomaticDiscounts • Boolean: Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see appliedDiscount) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.
Anchor to alertsalerts • [ResourceAlert!]!non-null: The list of alerts raised while calculating.
Anchor to allVariantPricesOverriddenallVariantPricesOverridden • Boolean!non-null: Whether all variant prices have been overridden.
Anchor to amountDueLaterSetamountDueLaterSet • MoneyBag!non-null: The amount due later. When there are payment terms, this is the total price minus the deposit amount (if any). When there are no payment terms, this is 0.
Anchor to amountDueNowSetamountDueNowSet • MoneyBag!non-null: The amount due now. When there are payment terms this is the value of the deposit (0 by default). When there are no payment terms, this is the total price.
Anchor to anyVariantPricesOverriddenanyVariantPricesOverridden • Boolean!non-null: Whether any variant prices have been overridden.
Anchor to appliedDiscountappliedDiscount • DraftOrderAppliedDiscount: The custom order-level discount applied.
Anchor to availableShippingRatesavailableShippingRates • [ShippingRate!]!non-null: The available shipping rates. Requires a customer with a valid shipping address and at least one line item.
Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress • Boolean!non-null: Whether the billing address matches the shipping address.
Anchor to currencyCodecurrencyCode • CurrencyCode!non-null: The shop currency used for calculation.
Anchor to customercustomer • Customer: The customer who will be sent an invoice.
Anchor to depositdeposit • DepositConfiguration: The portion required to be paid at checkout.
Anchor to discountCodesdiscountCodes • [String!]!non-null: All discount codes applied.
Anchor to lineItemslineItems • [CalculatedDraftOrderLineItem!]!non-null: The list of the line items in the calculated draft order.
Anchor to lineItemsSubtotalPricelineItemsSubtotalPrice • MoneyBag!non-null: A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.
Anchor to phonephone • String: The assigned phone number.
Anchor to platformDiscountsplatformDiscounts • [DraftOrderPlatformDiscount!]!non-null: The list of platform discounts applied.
Anchor to presentmentCurrencyCodepresentmentCurrencyCode • CurrencyCode!non-null: The payment currency used for calculation.
Anchor to purchasingEntitypurchasingEntity • PurchasingEntity: The purchasing entity.
Anchor to shippingLineshippingLine • ShippingLine: The line item containing the shipping information and costs.
Anchor to subtotalPriceSetsubtotalPriceSet • MoneyBag!non-null: The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
Anchor to taxesIncludedtaxesIncluded • Boolean!non-null: Whether the line item prices include taxes.
Anchor to taxLinestaxLines • [TaxLine!]!non-null: The list of of taxes lines charged for each line item and shipping line.
Anchor to totalDiscountsSettotalDiscountsSet • MoneyBag!non-null: Total discounts.
Anchor to totalLineItemsPriceSettotalLineItemsPriceSet • MoneyBag!non-null: Total price of line items.
Anchor to totalPriceSettotalPriceSet • MoneyBag!non-null: The total price, includes taxes, shipping charges, and discounts.
Anchor to totalQuantityOfLineItemstotalQuantityOfLineItems • Int!non-null: The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle.
Anchor to totalShippingPriceSettotalShippingPriceSet • MoneyBag!non-null: The total shipping price.
Anchor to totalTaxSettotalTaxSet • MoneyBag!non-null: The total tax.
Anchor to transformerFingerprinttransformerFingerprint • String: Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified.
Anchor to warningswarnings • [DraftOrderWarning!]!non-null: The list of warnings raised while calculating.

Show

deprecated fields Deprecated

Anchor to marketNamemarketName • String!non-nullDeprecated: The name of the selected market. This field is now incompatible with Markets.
Anchor to marketRegionCountryCodemarketRegionCountryCode • CountryCode!non-nullDeprecated: The selected country code that determines the pricing. This field is now incompatible with Markets.
Anchor to subtotalPricesubtotalPrice • Money!non-nullDeprecated: The subtotal, in shop currency, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes. Use subtotalPriceSet instead.
Anchor to totalPricetotalPrice • Money!non-nullDeprecated: The total price, in shop currency, includes taxes, shipping charges, and discounts. Use totalPriceSet instead.
Anchor to totalShippingPricetotalShippingPrice • Money!non-nullDeprecated: The total shipping price in shop currency. Use totalShippingPriceSet instead.
Anchor to totalTaxtotalTax • Money!non-nullDeprecated: The total tax in shop currency. Use totalTaxSet instead.

Was this section helpful?

Anchor to MutationsMutations

Anchor to draftOrderCalculate draftOrderCalculate • mutation: Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.

Was this section helpful?