cart query
Use the cart query to retrieve information about a particular cart.
Cart functionality is defined in the Quote module. A Quote represents the contents of a customer’s shopping cart. It is responsible for performing tasks such as:
- Tracking each item in the cart, including the quantity and base cost
- Determining estimated shipping costs
- Calculating subtotals, computing additional costs, applying coupons, and determining the payment method
Syntax
{cart(cart_id: String!) {Cart}}
Sample queries
Cart ready for checkout
The following query shows the status of a cart that is ready to be converted into an order.
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
cart(cart_id: "CYmiiQRjPVc2gJUc5r7IsBmwegVIFO43") {
email
billing_address {
city
country {
code
label
}
firstname
lastname
postcode
region {
code
label
}
street
telephone
}
shipping_addresses {
firstname
lastname
street
city
region {
code
label
}
country {
code
label
}
telephone
pickup_location_code
available_shipping_methods {
amount {
currency
value
}
available
carrier_code
carrier_title
error_message
method_code
method_title
price_excl_tax {
value
currency
}
price_incl_tax {
value
currency
}
}
selected_shipping_method {
amount {
value
currency
}
carrier_code
carrier_title
method_code
method_title
}
}
items {
id
product {
name
sku
}
quantity
}
available_payment_methods {
code
title
}
selected_payment_method {
code
title
}
applied_coupons {
code
}
prices {
grand_total {
value
currency
}
}
}
}
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
{
"data": {
"cart": {
"email": "roni_cost@example.com",
"billing_address": {
"city": "Calder",
"country": {
"code": "US",
"label": "US"
},
"firstname": "Veronica",
"lastname": "Costello",
"postcode": "49628-7978",
"region": {
"code": "MI",
"label": "Michigan"
},
"street": [
"6146 Honey Bluff Parkway"
],
"telephone": "(555) 229-3326"
},
"shipping_addresses": [
{
"firstname": "Veronica",
"lastname": "Costello",
"street": [
"6146 Honey Bluff Parkway"
],
"city": "Calder",
"region": {
"code": "MI",
"label": "Michigan"
},
"country": {
"code": "US",
"label": "US"
},
"telephone": "(555) 229-3326",
"pickup_location_code": "txspeqs",
"available_shipping_methods": [
{
"amount": {
"currency": "USD",
"value": 10
},
"available": true,
"carrier_code": "tablerate",
"carrier_title": "Best Way",
"error_message": "",
"method_code": "bestway",
"method_title": "Table Rate",
"price_excl_tax": {
"value": 10,
"currency": "USD"
},
"price_incl_tax": {
"value": 10,
"currency": "USD"
}
},
{
"amount": {
"currency": "USD",
"value": 15
},
"available": true,
"carrier_code": "flatrate",
"carrier_title": "Flat Rate",
"error_message": "",
"method_code": "flatrate",
"method_title": "Fixed",
"price_excl_tax": {
"value": 15,
"currency": "USD"
},
"price_incl_tax": {
"value": 15,
"currency": "USD"
}
}
],
"selected_shipping_method": {
"amount": {
"value": 10,
"currency": "USD"
},
"carrier_code": "tablerate",
"carrier_title": "Best Way",
"method_code": "bestway",
"method_title": "Table Rate"
}
}
],
"items": [
{
"id": "14",
"product": {
"name": "Strive Shoulder Pack",
"sku": "24-MB04"
},
"quantity": 2
},
{
"id": "17",
"product": {
"name": "Savvy Shoulder Tote",
"sku": "24-WB05"
},
"quantity": 1
}
],
"available_payment_methods": [
{
"code": "braintree_cc_vault",
"title": "Stored Cards (Braintree)"
},
{
"code": "braintree",
"title": "Credit Card (Braintree)"
},
{
"code": "checkmo",
"title": "Check / Money order"
}
],
"selected_payment_method": {
"code": "checkmo",
"title": "Check / Money order"
},
"applied_coupons": null,
"prices": {
"grand_total": {
"value": 105.26,
"currency": "USD"
}
}
}
}
}
Cart discounts
In this query, the Buy 3 tee shirts and get the 4th free cart price rule from the sample data is active. This rule was modified slightly to add the label 3T1free. (If a cart price rule does not have a label, Magento returns a default label of Discount.) A custom rule in which the customer saves 10% on the order by applying a discount code is also in effect.
The 3T1free rule is applied first, and Magento returns the price of a single shirt, $29, as the discount. Magento then applies a 10% discount to the remaining total of the products in the 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
cart(cart_id: "v7jYJUjvPeHbdMJRcOfZIeQhs2Xc2ZKT") {
email
items {
id
prices {
total_item_discount {
value
}
price {
value
}
discounts {
label
amount {
value
}
}
}
product {
name
sku
}
quantity
}
applied_coupons {
code
}
prices {
discounts {
amount {
value
}
label
}
grand_total {
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{
"data": {
"cart": {
"email": "roni_cost@example.com",
"items": [
{
"id": "43",
"prices": {
"total_item_discount": {
"value": 37.7
},
"price": {
"value": 29
},
"discounts": [
{
"label": "3T1free",
"amount": {
"value": 29
}
},
{
"label": "10% Off for New Customers",
"amount": {
"value": 8.7
}
}
]
},
"product": {
"name": "Elisa EverCool™ Tee",
"sku": "WS06"
},
"quantity": 4
}
],
"applied_coupons": [
{
"code": "NEW"
}
],
"prices": {
"discounts": [
{
"amount": {
"value": 29
},
"label": "3T1free"
},
{
"amount": {
"value": 8.7
},
"label": "10% Off for New Customers"
}
],
"grand_total": {
"value": 84.76
}
}
}
}
}
Tier price example
In the following example, tier prices has been established for product 24-UG01 and 24-UG05, as shown in the following table:
| Product | Quantity | Fixed/Discount | Amount |
|---|---|---|---|
| 24-UG01 | 5 | Discount | 5% |
| 24-UG01 | 10 | Discount | 10% |
| 24-UG01 | 15 | Discount | 15% |
| 24-UG05 | 5 | Fixed | $16 |
| 24-UG05 | 10 | Fixed | $11 |
The cart in the example contains 12 units of 24-UG05 and 8 units of 24-UG-01, so the price of 24-UG05 is $11, and the price of 24-UG01 is $18.05 (5% off).
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
35
36
37
38
39
40
41
42
43
44
query {
cart(cart_id: "v7jYJUjvPeHbdMJRcOfZIeQhs2Xc2ZKT"){
items {
id
quantity
product{
name
sku
price_tiers {
quantity
final_price {
value
}
discount {
amount_off
percent_off
}
}
}
prices{
price{
value
}
}
}
prices {
discounts {
label
amount {
value
}
}
subtotal_excluding_tax {
value
}
applied_taxes {
label
amount {
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
{
"data": {
"cart": {
"items": [
{
"id": "65",
"quantity": 12,
"product": {
"name": "Go-Get'r Pushup Grips",
"sku": "24-UG05",
"price_tiers": [
{
"quantity": 5,
"final_price": {
"value": 16
},
"discount": {
"amount_off": 3,
"percent_off": 15.79
}
},
{
"quantity": 10,
"final_price": {
"value": 11
},
"discount": {
"amount_off": 8,
"percent_off": 42.11
}
}
]
},
"prices": {
"price": {
"value": 11
}
}
},
{
"id": "66",
"quantity": 8,
"product": {
"name": "Quest Lumaflex™ Band",
"sku": "24-UG01",
"price_tiers": [
{
"quantity": 5,
"final_price": {
"value": 18.05
},
"discount": {
"amount_off": 0.95,
"percent_off": 5
}
},
{
"quantity": 10,
"final_price": {
"value": 17.1
},
"discount": {
"amount_off": 1.9,
"percent_off": 10
}
},
{
"quantity": 15,
"final_price": {
"value": 16.15
},
"discount": {
"amount_off": 2.85,
"percent_off": 15
}
}
]
},
"prices": {
"price": {
"value": 18.05
}
}
}
],
"prices": {
"discounts": [
{
"label": "200",
"amount": {
"value": 55.28
}
}
],
"subtotal_excluding_tax": {
"value": 276.4
},
"applied_taxes": [
{
"label": "US-MI-*-Rate 1",
"amount": {
"value": 18.24
}
}
]
}
}
}
}
Input attributes
| Attribute | Data Type | Description |
|---|---|---|
cart_id |
String! | A 32-character string that is created when you create a cart |
Output attributes
The top-level Cart object is listed first. All interfaces and child objects are listed in alphabetical order.
Cart object
The Cart object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
applied_coupon |
AppliedCoupon |
Deprecated. Use applied_coupons instead |
applied_coupons |
[AppliedCoupon] |
An array of AppliedCoupon objects. Each 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 |
id |
ID! | The ID of the cart |
is_virtual |
Boolean! | Indicates whether the cart contains only virtual products |
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 |
total_quantity |
Float! | Total Quantity of products in the cart |
AppliedCoupon object
The AppliedCoupon object must contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
code |
String! | The coupon code applied to the order |
AppliedGiftCard object
The AppliedGiftCard object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
applied_balance |
Money | Applied balance to the current cart |
code |
String | The gift card code applied to the order |
current_balance |
Money | Current balance remaining on the gift card |
expiration_date |
String | Gift card expiration date |
AppliedStoreCredit object
The AppliedStoreCredit object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
applied_balance |
Money | The amount of store credit applied to the current cart |
current_balance |
Money | The customer’s store credit balance before applying store credit to the cart |
enabled |
Boolean | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned |
AvailablePaymentMethod object
The AvailablePaymentMethod object must contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
code |
String! | The payment method code |
title |
String! | The payment method title |
AvailableShippingMethod object
The AvailableShippingMethod object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
amount |
Money! | The cost of shipping using this shipping method |
available |
Boolean! | Indicates whether this shipping method can be applied to the cart |
base_amount |
Money | Deprecated. This attribute is not applicable for GraphQL |
carrier_code |
String! | A string that identifies a commercial carrier or an offline shipping method |
carrier_title |
String! | The label for the carrier code |
error_message |
String | Describes an error condition |
method_code |
String | A shipping method code associated with a carrier. Could be null if method is not available |
method_title |
String | The label for the method code. Could be null if method is not available |
price_excl_tax |
Money! | The cost of shipping using this shipping method, excluding tax |
price_incl_tax |
Money! | The cost of shipping using this shipping method, excluding tax |
BillingCartAddress object
The BillingCartAddress object implements CartAddressInterface. It does not define any additional attributes.
CartAddressCountry object
The CartAddressCountry object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
code |
String! | The country code |
label |
String! | The display label for the country |
CartAddressInterface
The CartAddressInterface contains the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
city |
String! | The city specified for the billing address |
company |
String | The company specified for the billing address |
country |
CartAddressCountry! | The country code and label for the billing address |
customer_notes |
String | Comments made to the customer that accompanies the order |
firstname |
String! | The customer’s first name |
lastname |
String! | The customer’s last name |
postcode |
String | The postal code for the billing address |
region |
CartAddressRegion | An object containing the region label and code |
street |
[String!]! | The street for the billing address |
telephone |
String! | The telephone number for the billing address |
CartAddressRegion object
The CartAddressRegion object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
code |
String | The state or province code |
label |
String | The display label for the region |
region_id |
Int | The unique ID for a pre-defined region |
CartDiscount object
The CartDiscount object must contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
amount |
Money | The amount of all discounts applied to the cart |
label |
[String!]! | A concatenated list of strings that describe each applied discount |
CartItemInterface
The CartItemInterface can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
id |
String | ID of the item |
prices |
CartItemPrices | Includes the price of an item, any applied discounts, and calculated totals |
product |
ProductInterface | Contains attributes that are common to all types of products |
quantity |
Float | The number of items in the cart |
CartItemPrices object
The CartItemPrices object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
discounts |
[Discount] | An array of discounts to be applied to the cart item |
price |
Money! | The price of the item before any discounts were applied |
row_total |
Money! | The value of the price multiplied by the quantity of the item |
row_total_including_tax |
Money! | The value of row_total plus the tax applied to the item |
total_item_discount |
Money | The total of all discounts applied to the item |
CartItemQuantity object
The CartItemQuantity data type has been deprecated. Use the cart_items_v2 attribute with the CartItemInterface instead.
| Attribute | Data Type | Description |
|---|---|---|
cart_item_id |
Int! | Deprecated. Use CartItemInterface.id instead |
quantity |
Float! | Deprecated. Use CartItemInterface.quantity instead |
CartPrices object
The CartPrices object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
applied_taxes |
[CartTaxItem] | An array containing the names and amounts of taxes applied to the item |
discount |
CartDiscount | Deprecated. Use discounts instead |
discounts |
[Discount] | An array containing all discounts applied to the cart |
grand_total |
Money | The total, including discounts, taxes, shipping, and other fees |
subtotal_excluding_tax |
Money | Subtotal without taxes |
subtotal_including_tax |
Money | Subtotal with taxes |
subtotal_with_discount_excluding_tax |
Money | Subtotal with any discounts applied, but not taxes |
CartTaxItem object
The CartTaxItem object must contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
amount |
Money! | The amount of tax applied to the item |
label |
String! | The description of the tax |
Discount object
A discount can be applied to the cart as a whole or to an item.
If a cart rule does not have a label, Magento uses Discount as the default label.
The Discount object must contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
amount |
Money! | The amount of the discount applied to the cart |
label |
String! | The description of the discount |
SelectedPaymentMethod object
The SelectedPaymentMethod object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
code |
String! | The payment method code |
purchase_order_number |
String | The purchase order number |
title |
String! | The payment method title |
SelectedShippingMethod object
The SelectedShippingMethod object can contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
amount |
Money! | The cost of shipping using this shipping method |
base_amount |
Money | Deprecated. This attribute is not applicable for GraphQL |
carrier_code |
String! | A string that identifies a commercial carrier or an offline shipping method |
carrier_title |
String! | The label for the carrier code |
method_code |
String! | A shipping method code associated with a carrier |
method_title |
String! | The label for the method code |
ShippingCartAddress object
The ShippingCartAddress object implements CartAddressInterface. It can also contain the following attributes.
| Attribute | Data Type | Description |
|---|---|---|
available_shipping_methods |
[AvailableShippingMethod] | An array that lists the shipping methods that can be applied to the cart |
cart_items |
[CartItemQuantity] | Deprecated. Use cart_items_v2 instead |
cart_items_v2 |
CartItemInterface | An array that lists the items in the cart |
items_weight |
Float | Deprecated. This attribute is not applicable for GraphQL |
selected_shipping_method |
SelectedShippingMethod | An object that describes the selected shipping method |
pickup_location_code |
String | The code of the in-store pickup location where the customer will receive the order |