addSimpleProductsToCart mutation
Simple products are physical products that do not have variations, such as color, size, or price. The addSimpleProductsToCart mutation allows you to add multiple simple products to the cart at the same time, but you cannot add other product types with this mutation. To add a simple product to a cart, you must provide the cart ID, the SKU, and the quantity. You can also optionally provide customizable options.
Syntax
mutation: {addSimpleProductsToCart(input: AddSimpleProductsToCartInput): {AddSimpleProductsToCartOutput}}
Example usage
These examples show the minimal payload and a payload that includes customizable options.
Add a simple product to a cart
The following example adds a simple product to a cart. The response contains the entire contents of the customer’s cart.
Request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
mutation {
addSimpleProductsToCart(
input: {
cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
cart_items: [
{
data: {
quantity: 1
sku: "24-MB04"
}
}
]
}
) {
cart {
items {
id
product {
name
sku
}
quantity
}
}
}
}
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"data": {
"addSimpleProductsToCart": {
"cart": {
"items": [
{
"id": "13",
"product": {
"name": "Strive Shoulder Pack",
"sku": "24-MB04"
},
"quantity": 1
}
]
}
}
}
}
Add a simple product with customizable options to a cart
If a product has a customizable option, you can specify the option’s value in the addSimpleProductsToCart request.
Request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
mutation {
addSimpleProductsToCart (input: {
cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG",
cart_items: {
data: {
sku: "simple"
quantity: 1
},
customizable_options: [
{
id: 121
value_string: "field value"
}
]
}
}) {
cart {
items {
product {
name
}
quantity
... on SimpleCartItem {
customizable_options {
label
values {
value
}
}
}
}
}
}
}
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
"data": {
"addSimpleProductsToCart": {
"cart": {
"items": [
{
"product": {
"name": "simple"
},
"quantity": 1,
"customizable_options": [
{
"label": "Field Option",
"values": [
{
"value": "field value"
}
]
}
]
}
]
}
}
}
}
Input attributes
The top-level AddSimpleProductsToCartInput object is listed first. All child objects are listed in alphabetical order.
AddSimpleProductsToCartInput object
The AddSimpleProductsToCartInput object must contain the following attributes:
| Attribute | Data Type | Description |
|---|---|---|
cart_id |
String! | The unique ID that identifies the customer’s cart |
cart_items |
SimpleProductCartItemInput! | Contains the cart item IDs and quantity of each item |
CartItemInput object
The CartItemInput object must contain the following attributes:
| Attribute | Data Type | Description |
|---|---|---|
id |
Int! | A unique ID assigned to the customizable option |
value_string |
String! | A value assigned to the customizable option |
CustomizableOptionInput object
The CustomizableOptionInput object must contain the following attributes:
| Attribute | Data Type | Description |
|---|---|---|
id |
Int! | A unique ID assigned to the customizable option |
value_string |
String! | A value assigned to the customizable option |
SimpleProductCartItemInput object
The SimpleProductCartItemInput object must contain the following attributes:
customizable_options |
[CustomizableOptionInputSimple] | An array that defines customizable options for the product |
data |
CartItemInput! | An object containing the sku and quantity of the product. |
Output attributes
The AddSimpleProductsToCartOutput object contains the Cart object.
| Attribute | Data Type | Description |
|---|---|---|
cart |
Cart! | Describes the contents of the specified shopping cart |
Cart object
| Attribute | Data Type | Description |
|---|---|---|
applied_coupon |
AppliedCoupon |
The AppliedCoupon object contains the code text attribute, which specifies the coupon code |
applied_gift_cards |
[AppliedGiftCard] |
An array of AppliedGiftCard objects. An AppliedGiftCard object contains the code text attribute, which specifies the gift card code. applied_gift_cards is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module |
applied_store_credit |
AppliedStoreCredit |
Contains store credit information applied to the cart. applied_store_credit is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module |
available_payment_methods |
[AvailablePaymentMethod] | Available payment methods |
billing_address |
BillingCartAddress! | Contains the billing address specified in the customer’s cart |
email |
String | The customer’s email address |
items |
[CartItemInterface] | Contains the items in the customer’s cart |
prices |
CartPrices | Contains subtotals and totals |
selected_payment_method |
SelectedPaymentMethod | Selected payment method |
shipping_addresses |
[ShippingCartAddress]! | Contains one or more shipping addresses |
Cart query output provides more information about the Cart object.