orderEditAddLineItemDiscount - admin-graphql - MUTATION
Version: 2024-10
Description:
Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
Access Scopes
`write_order_edits` access scope. Also: The user must have apply_discounts_to_orders permission.
Arguments
-
discount:
OrderEditAppliedDiscountInput! -
The discount to add to the line item.
-
id:
ID! -
The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)
to update.
-
lineItemId:
ID! -
The ID of the calculated line item to add the discount to.
Returns
-
addedDiscountStagedChange:
OrderStagedChangeAddLineItemDiscount
The discount applied to a line item during this order edit.
-
calculatedLineItem:
CalculatedLineItem
The line item with the edits applied but not saved.
-
calculatedOrder:
CalculatedOrder
An order with the edits applied but not saved.
-
userErrors:
UserError!
The list of errors that occurred from executing the mutation.
Examples