Skip to main content
Anchor to DraftOrderCalculatePayload

DraftOrderCalculatePayload

payload

Return type for draftOrderCalculate mutation.

Anchor to FieldsFields

Anchor to calculatedDraftOrdercalculatedDraftOrder
•CalculatedDraftOrder

The calculated properties for a draft order.

Anchor to userErrorsuserErrors
•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

Anchor to draftOrderCalculatedraftOrderCalculate
•mutation

Calculates the properties of a DraftOrder without creating it. Returns pricing information including CalculatedDraftOrderLineItem totals, shipping charges, applicable discounts, and tax calculations based on the provided Customer and MailingAddress information.

Use this mutation to preview total taxes and prices before creating a draft order. It's particularly useful when working with B2B PurchasingEntity or when you need to determine costs without committing to a draft order. Learn more about calculating draft orders for B2B purchasing entities.

Arguments

Anchor to inputinput
•DraftOrderInput!
required

The fields for the draft order.

Was this section helpful?