orderEditAddVariant mutation

Add a line item from an existing product variant.

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 orderEditAddVariant($id: ID!, $variantId: ID!, $quantity: Int!) { orderEditAddVariant(id: $id, variantId: $variantId, 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=”, “variantId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “quantity”: 1 }

Arguments

Argument Description
allowDuplicates
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether or not this mutation can create a line item with a variant that is already present on the order. Default false.
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

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

)		 The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided.
quantity
(
[Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

) REQUIRED		 The amount of the item to add to the order. Must be a positive value.
variantId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the variant to add.

Return fields

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