orderEditSetQuantity mutation

Set the quantity of an item on the order.

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 orderEditSetQuantity($id: ID!, $lineItemId: ID!, $quantity: Int!) { orderEditSetQuantity(id: $id, lineItemId: $lineItemId, quantity: $quantity) { 
  1. <font style="color:#1F61A0;">calculatedLineItem</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">calculatedOrder</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">field</font>
  17.   <font style="color:#1F61A0;">message</font>
  19. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “lineItemId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “quantity”: 1 }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

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

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

)		 The ID of the location that will fulfill any added items, or the ID of the location that the restocked item will be made available at, if ‘restock’ is set to true.
quantity
(
[Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

) REQUIRED		 The new quantity of the line item. Cannot be negative.
restock
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether or not to restock the line item when the updated quantity is less than the original quantity.

Return fields

  • calculatedLineItem ([CalculatedLineItem](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    The line item with changes calculated.
  • 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.