Order
Return type for mutation.
Anchor to FieldsFields
- calculatedLineItem (CalculatedLineItem)
- calculatedOrder (CalculatedOrder)
- orderEditSession (OrderEditSession)
- userErrors ([UserError!]!)
- Anchor to calculatedLineItemcalculated•Calculated
Line Item Line Item The calculated line item that's added during this order edit.
- Anchor to calculatedOrdercalculated•Calculated
Order Order The calculated order with the edits applied but not saved.
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- orderEditAddVariant (OrderEditAddVariantPayload)
- •mutation
Adds a
as a line item to anOrderthat's being edited. The mutation respects the variant's contextual pricing.You can specify a
Locationto check for inventory availability and control whether duplicate variants are allowed. Thequantitymust be a positive value.Learn more about editing existing orders.
- •ID!required
The ID of the calculated order or the order edit session to edit.
- Anchor to variantIdvariant•ID!
Id required The ID of the variant to add.
- Anchor to locationIdlocation•ID
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 allowDuplicatesallow•Boolean
Duplicates Default:false Whether the mutation can create a line item for a variant that's already on the calculated order.
Arguments
- •ID!