orderEditAddVariant

mutation

Requires write_order_edits access scope.

Adds a line item from an existing product variant. As of API version 2025-04, the orderEditAddVariant API will respect the contextual pricing of the variant.

Arguments

Anchor to allowDuplicatesallowDuplicates • BooleanDefault:false: Whether the mutation can create a line item for a variant that's already on the calculated order.
Anchor to idid • ID!required: The ID of the calculated order or the order edit session to edit.
Anchor to locationIdlocationId • ID: The ID of the location to check for inventory availability. A default location ID is chosen automatically if none is provided.
Anchor to quantityquantity • Int!required: The quantity of the item to add to the order. Must be a positive value.
Anchor to variantIdvariantId • ID!required: The ID of the variant to add.

Was this section helpful?

Anchor to OrderEditAddVariantPayload returnsOrderEditAddVariantPayload returns

Anchor to calculatedLineItemcalculatedLineItem • CalculatedLineItem: The calculated line item that's added during this order edit.
Anchor to calculatedOrdercalculatedOrder • CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession • OrderEditSession: The order edit session 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

1mutation orderEditAddVariant($allowDuplicates: Boolean, $id: ID!, $locationId: ID, $quantity: Int!, $variantId: ID!) {
2  orderEditAddVariant(allowDuplicates: $allowDuplicates, id: $id, locationId: $locationId, quantity: $quantity, variantId: $variantId) {
3    calculatedLineItem {
4      # CalculatedLineItem fields
5    }
6    calculatedOrder {
7      # CalculatedOrder fields
8    }
9    orderEditSession {
10      # OrderEditSession fields
11    }
12    userErrors {
13      field
14      message
15    }
16  }
17}

Input

1{
2  "allowDuplicates": true,
3  "id": "gid://shopify/<objectName>/10079785100",
4  "locationId": "gid://shopify/<objectName>/10079785100",
5  "quantity": 1,
6  "variantId": "gid://shopify/<objectName>/10079785100"
7}

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