orderEditAddLineItemDiscount
mutation

Choose a version:

Requires write_order_edits access scope. Also: The user must have apply_discounts_to_orders permission.

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.

Anchor to section titled 'Arguments'

Arguments

Anchor to discount discount OrderEditAppliedDiscountInput! required: The discount to add to the line item.
Anchor to id id ID! required: The ID of the calculated order or the order edit session to edit.
Anchor to lineItemId lineItemId ID! required: The ID of the calculated line item to add the discount to.

Was this section helpful?

Anchor to section titled 'OrderEditAddLineItemDiscountPayload returns'

OrderEditAddLineItemDiscountPayload returns

Anchor to OrderEditAddLineItemDiscountPayload.addedDiscountStagedChange addedDiscountStagedChange OrderStagedChangeAddLineItemDiscount: The discount applied to a line item during this order edit.
Anchor to OrderEditAddLineItemDiscountPayload.calculatedLineItem calculatedLineItem CalculatedLineItem: The line item with the edits applied but not saved.
Anchor to OrderEditAddLineItemDiscountPayload.calculatedOrder calculatedOrder CalculatedOrder: An order with the edits applied but not saved.
Anchor to OrderEditAddLineItemDiscountPayload.orderEditSession orderEditSession OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to OrderEditAddLineItemDiscountPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditAddLineItemDiscount

Query Reference for MUTATION: orderEditAddLineItemDiscount

"mutation orderEditAddLineItemDiscount($discount: OrderEditAppliedDiscountInput!, $id: ID!, $lineItemId: ID!) {\n  orderEditAddLineItemDiscount(discount: $discount, id: $id, lineItemId: $lineItemId) {\n    addedDiscountStagedChange {\n      # OrderStagedChangeAddLineItemDiscount fields\n    }\n    calculatedLineItem {\n      # CalculatedLineItem fields\n    }\n    calculatedOrder {\n      # CalculatedOrder fields\n    }\n    orderEditSession {\n      # OrderEditSession fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditAddLineItemDiscount

"{\n  \"discount\": {\n    \"description\": \"<your-description>\",\n    \"fixedValue\": {\n      \"amount\": \"29.99\",\n      \"currencyCode\": \"AED\"\n    },\n    \"percentValue\": 1.1\n  },\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"lineItemId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: orderEditAddLineItemDiscount

"input OrderEditAppliedDiscountInput {\n  description: String\n  fixedValue: MoneyInput\n  percentValue: Float\n}\n\ninput MoneyInput {\n  amount: Decimal!\n  currencyCode: CurrencyCode!\n}\n"

Display Examples for MUTATION: orderEditAddLineItemDiscount

[]

orderEditAddLineItemDiscountmutation

Arguments

OrderEditAddLineItemDiscountPayload returns

orderEditAddLineItemDiscount
mutation