Skip to main content
Anchor to OrderEditUpdateDiscountPayload

OrderEditUpdateDiscountPayload

payload

Return type for orderEditUpdateDiscount mutation.

•CalculatedOrder

An order with the edits applied but not saved.

Show fields
•OrderEditSession

The order edit session with the edits applied but not saved.

Show fields
•[OrderEditUpdateDiscountUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Updates a manual line level discount on the current order edit. If the order has an existing write-off, mutations such as this one, which reduce the order total, can reduce the written-off amount automatically when the edit is committed and the order total before write-offs falls below the remaining written-off amount. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Show payload

Arguments

•OrderEditAppliedDiscountInput!
required

The updated discount.

Show input fields
Anchor to discountApplicationIddiscountApplicationId
•ID!
required

The ID of the calculated discount application to update.

•ID!
required

The ID of the calculated order or the order edit session to edit. This is the edit used to update the discount.



Was this section helpful?