Skip to main content
Anchor to OrderStagedChangeAddManualDiscount

OrderStagedChangeAddManualDiscount

object

Requires read_order_edits access scope.

A manual order-level discount staged during the current order edit.

•String!
non-null

The description of the discount.

•ID!
non-null

A globally-unique ID.

•PricingValue!
non-null

The pricing value of the discount.

Show union types

Was this section helpful?

•mutation

Adds a manual order-level discount during an order edit session.

The discount is allocated across all line items. The changes remain staged until committed with the orderEditCommit mutation.

If the edit already has a staged manual order-level discount, this replaces it. If the order already has an active manual order-level discount, remove it with orderEditRemoveDiscount first.

To change or remove the discount later in the edit, use orderEditUpdateDiscount or orderEditRemoveDiscount.

Show payload

Arguments

•OrderEditAppliedDiscountInput!
required

The manual order-level discount to add.

Show input fields
•ID!
required

The ID of the calculated order or the order edit session to edit.



Was this section helpful?