Choose a version:

orderEditSetQuantity

mutation

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.

Arguments

Anchor to idid •ID!required: The ID of the calculated order to edit. The edit changes the quantity on the line item.
Anchor to lineItemIdlineItemId •ID!required: The ID of the calculated line item to edit.
Anchor to quantityquantity •Int!required: The new quantity to set for the line item. This value cannot be negative.
Anchor to restockrestock •Boolean: Whether or not to restock the line item when the updated quantity is less than the original quantity.
Anchor to locationIdlocationId •IDDeprecated

Was this section helpful?

Anchor to OrderEditSetQuantityPayload returnsOrderEditSetQuantityPayload returns

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

Was this section helpful?

Mutation Reference

mutation orderEditSetQuantity($id: ID!, $lineItemId: ID!, $locationId: ID, $quantity: Int!, $restock: Boolean) {

orderEditSetQuantity(id: $id, lineItemId: $lineItemId, locationId: $locationId, quantity: $quantity, restock: $restock) {

calculatedLineItem {

# CalculatedLineItem fields

}

calculatedOrder {

# CalculatedOrder fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"lineItemId": "gid://shopify/<objectName>/10079785100",

"locationId": "gid://shopify/<objectName>/10079785100",

"quantity": 1,

"restock": true

}

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