orderEditSetQuantity
mutation

Choose a version:

Requires write_order_edits access scope.

Sets the quantity of a line item on an order that is being edited. 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 id id ID! required: The ID of the calculated order to edit. The edit changes the quantity on the line item.
Anchor to lineItemId lineItemId ID! required: The ID of the calculated line item to edit.
Anchor to quantity quantity Int! required: The new quantity to set for the line item. This value cannot be negative.
Anchor to restock restock Boolean: Whether or not to restock the line item when the updated quantity is less than the original quantity.

Was this section helpful?

Anchor to section titled 'OrderEditSetQuantityPayload returns'

OrderEditSetQuantityPayload returns

Anchor to OrderEditSetQuantityPayload.calculatedLineItem calculatedLineItem CalculatedLineItem: The calculated line item with the edits applied but not saved.
Anchor to OrderEditSetQuantityPayload.calculatedOrder calculatedOrder CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to OrderEditSetQuantityPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditSetQuantity

Query Reference for MUTATION: orderEditSetQuantity

"mutation orderEditSetQuantity($id: ID!, $lineItemId: ID!, $quantity: Int!) {\n  orderEditSetQuantity(id: $id, lineItemId: $lineItemId, quantity: $quantity) {\n    calculatedLineItem {\n      # CalculatedLineItem fields\n    }\n    calculatedOrder {\n      # CalculatedOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditSetQuantity

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"lineItemId\": \"gid://shopify/<objectName>/10079785100\",\n  \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n  \"quantity\": 1,\n  \"restock\": true\n}"

Schema Reference for MUTATION: orderEditSetQuantity

""

Display Examples for MUTATION: orderEditSetQuantity

[]

orderEditSetQuantitymutation

Arguments

OrderEditSetQuantityPayload returns

orderEditSetQuantity
mutation