CalculatedDraftOrder - admin-graphql - OBJECT

Version: 2024-10

Description:

The calculated fields for a draft order.

Access Scopes

`read_draft_orders` access scope.

Fields

  • acceptAutomaticDiscounts: 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.
  • alerts: ResourceAlert! - The list of alerts raised while calculating.
  • appliedDiscount: DraftOrderAppliedDiscount - The custom order-level discount applied.
  • availableShippingRates: ShippingRate! - The available shipping rates. Requires a customer with a valid shipping address and at least one line item.
  • billingAddressMatchesShippingAddress: Boolean! - Whether the billing address matches the shipping address.
  • currencyCode: CurrencyCode! - The shop currency used for calculation.
  • customer: Customer - The customer who will be sent an invoice.
  • discountCodes: String! - All discount codes applied.
  • lineItems: CalculatedDraftOrderLineItem! - The list of the line items in the calculated draft order.
  • lineItemsSubtotalPrice: MoneyBag! - A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.
  • marketName: String! - The name of the selected market.
  • marketRegionCountryCode: CountryCode! - The selected country code that determines the pricing.
  • phone: String - The assigned phone number.
  • platformDiscounts: DraftOrderPlatformDiscount! - The list of platform discounts applied.
  • presentmentCurrencyCode: CurrencyCode! - The payment currency used for calculation.
  • purchasingEntity: PurchasingEntity - The purchasing entity.
  • shippingLine: ShippingLine - The line item containing the shipping information and costs.
  • subtotalPrice: Money! - The subtotal, in shop currency, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
  • subtotalPriceSet: MoneyBag! - The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
  • taxLines: TaxLine! - The list of of taxes lines charged for each line item and shipping line.
  • taxesIncluded: Boolean! - Whether the line item prices include taxes.
  • totalDiscountsSet: MoneyBag! - Total discounts.
  • totalLineItemsPriceSet: MoneyBag! - Total price of line items.
  • totalPrice: Money! - The total price, in shop currency, includes taxes, shipping charges, and discounts.
  • totalPriceSet: MoneyBag! - The total price, includes taxes, shipping charges, and discounts.
  • totalQuantityOfLineItems: Int! - 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.
  • totalShippingPrice: Money! - The total shipping price in shop currency.
  • totalShippingPriceSet: MoneyBag! - The total shipping price.
  • totalTax: Money! - The total tax in shop currency.
  • totalTaxSet: MoneyBag! - The total tax.
  • transformerFingerprint: 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.
  • warnings: DraftOrderWarning! - The list of warnings raised while calculating.

Connections

Related queries

Related mutations

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

Related Unions

Examples