orderEditAddVariant
mutation

Choose a version:

Requires write_order_edits access scope.

Adds a line item from an existing product variant.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'OrderEditAddVariantPayload returns'

OrderEditAddVariantPayload returns

Anchor to OrderEditAddVariantPayload.calculatedLineItem calculatedLineItem CalculatedLineItem: The calculated line item that's added during this order edit.
Anchor to OrderEditAddVariantPayload.calculatedOrder calculatedOrder CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to OrderEditAddVariantPayload.orderEditSession orderEditSession OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to OrderEditAddVariantPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditAddVariant

Query Reference for MUTATION: orderEditAddVariant

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

Input Reference for MUTATION: orderEditAddVariant

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

Schema Reference for MUTATION: orderEditAddVariant

""

Display Examples for MUTATION: orderEditAddVariant

[]

orderEditAddVariantmutation

Arguments

OrderEditAddVariantPayload returns

orderEditAddVariant
mutation