draftOrderCalculate mutation

Version unstable

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

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
input ( DraftOrderInput! ) required

The fields for the draft order.

DraftOrderInput fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    The discount that will be applied to the draft order. A draft order line item can have one discount. A draft order can also have one order-level discount.

  • billingAddress (MailingAddressInput)

    The mailing address associated with the payment method.

  • customAttributes ([AttributeInput!])

    Extra information added to the customer.

  • customerId (ID)

    Customer associated with the draft order.

  • email (String)

    The customer's email address.

  • Product variant line item or custom line item associated to the draft order. Each draft order must include at least one line item.

  • localizationExtensions ([LocalizationExtensionInput!])

    The localization extensions attached to the draft order. For example, Tax IDs.

  • metafields ([MetafieldInput!])

    Metafields attached to the draft order.

  • note (String)

    The text of an optional note that a shop owner can attach to the draft order.

  • paymentTerms (PaymentTermsInput)

    The fields used to create payment terms.

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields attached to the draft order.

  • shippingAddress (MailingAddressInput)

    The mailing address to where the order will be shipped.

  • shippingLine (