checkoutLineItemsUpdate mutation
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates line items on a checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
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
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The checkout on which to update line items. |
lineItems
(
[CheckoutLineItemUpdateInput!]!
)
required
|
Line items to update. |
CheckoutLineItemUpdateInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
id (
ID
)The identifier of the line item.
-
quantity (
Int
)The quantity of the line item.
-
variantId (
ID
)The variant identifier of the line item.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead