orderEditAddLineItemDiscount mutation

Add a discount to an item added during this order edit.

Required access

write_order_edits access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) { orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) { 
  1. <font style="color:#1F61A0;">addedDiscountStagedChange</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">calculatedLineItem</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">calculatedOrder</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">id</font>
  17. <font style="color:#555555;">}</font>
  19. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  21.   <font style="color:#1F61A0;">field</font>
  23.   <font style="color:#1F61A0;">message</font>
  25. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “lineItemId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “discount”: {} }

Arguments

Argument Description
discount
(
[OrderEditAppliedDiscountInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordereditapplieddiscountinput)

) REQUIRED		 The discount to apply to the line item.
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the calculated order to add the discount to.
lineItemId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of a line item added during this edit to add the discount to.

OrderEditAppliedDiscountInput fields

  • description ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The description of the discount.
  • fixedValue ([MoneyInput](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyinput))
    The value of the discount as a fixed amount.
  • percentValue ([Float](https://shopify.dev/docs/admin-api/graphql/reference/scalar#float-2021-01))
    The value of the discount as a percentage.

Return fields

  • addedDiscountStagedChange ([OrderStagedChangeAddLineItemDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderstagedchangeaddlineitemdiscount))
    The staged change produced by this mutation.
  • calculatedLineItem ([CalculatedLineItem](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    The line item with the discount applied.
  • calculatedOrder ([CalculatedOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedorder))
    An order with the edits calculated.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.