Skip to main content

AddOrderLineItemInput

A line item to add to an order created through the API, with an idempotency key so that the call can safely be repeated.

input AddOrderLineItemInput {
orderId: ID!
idempotencyKey: String!
lineItem: CreateOrderLineItemInput!
}

Fields​

AddOrderLineItemInput.orderId ● ID! non-null scalar​

ID of the order to add the line item to.

AddOrderLineItemInput.idempotencyKey ● String! non-null scalar​

Key the client chooses for this line item, unique within the order, e.g. the ID of the line item in the external system; between 1 and 255 characters, compared exactly. Calling the mutation again with a key it already added a line item for to the order returns the order unchanged, even when that line item was removed since, so a call that timed out can safely be repeated.

AddOrderLineItemInput.lineItem ● CreateOrderLineItemInput! non-null input​

The line item with its final price.

Member Of​

addOrderLineItem mutation