checkoutLineItemsAdd mutation
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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
Adds a list of line items to 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 ID of the checkout. |
lineItems
(
[CheckoutLineItemInput!]!
)
required
|
A list of line item objects to add to the checkout. |
CheckoutLineItemInput fields
-
customAttributes (
[AttributeInput!]
)Extra information in the form of an array of Key-Value pairs about the line item.
-
quantity (
Int!
) RequiredThe quantity of the line item.
-
variantId (
ID!
) RequiredThe identifier of the product variant for 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