checkoutLineItemsReplace mutation

Sets a list of line items to a checkout.

Required access

unauthenticated_write_checkouts access scope

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.


Arguments

checkoutId ( ID! ) required

The ID of the checkout.

lineItems ( [CheckoutLineItemInput!]! ) required

A list of line item objects to set on the checkout.

CheckoutLineItemInput fields

customAttributes ([AttributeInput!])

Extra information in the form of an array of Key-Value pairs about the line item.

quantity (Int!) Required

The quantity of the line item.

variantId (ID!) Required

The identifier of the product variant for the line item.

Return fields

checkout (Checkout)

The updated checkout object.

userErrors ([CheckoutUserError!]!)

List of errors that occurred executing the mutation.

Sets a list of line items to a checkout.

Required access

unauthenticated_write_checkouts access scope

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.


Arguments

checkoutId ( ID! ) required

The ID of the checkout.

lineItems ( [CheckoutLineItemInput!]! ) required

A list of line item objects to set on the checkout.

CheckoutLineItemInput fields

customAttributes ([AttributeInput!])

Extra information in the form of an array of Key-Value pairs about the line item.

quantity (Int!) Required

The quantity of the line item.

variantId (ID!) Required

The identifier of the product variant for the line item.

Return fields

checkout (Checkout)

The updated checkout object.

userErrors ([CheckoutUserError!]!)

List of errors that occurred executing the mutation.

Sets a list of line items to a checkout.

Required access

unauthenticated_write_checkouts access scope

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.


Arguments

checkoutId ( ID! ) required

The ID of the checkout.

lineItems ( [CheckoutLineItemInput!]! ) required

A list of line item objects to set on the checkout.

CheckoutLineItemInput fields

customAttributes ([AttributeInput!])

Extra information in the form of an array of Key-Value pairs about the line item.

quantity (Int!) Required

The quantity of the line item.

variantId (ID!) Required

The identifier of the product variant for the line item.

Return fields

checkout (Checkout)

The updated checkout object.

userErrors ([CheckoutUserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up