XM
Members
Update Cart
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
PATCH https://{baseurl}/api-cart/cart/{cartId}/items
Copied!
The ideal use case for this API is to allow your customers to decrement the quantity of an item in their cart, any time before billing.
If the requested quantity is not in stock, the API still returns a success response but the inventory error is displayed in the 'errors' object within the success response.
To add new items or increment item quantity, the Add Items to Cart API is recommended. To remove existing items, the Remove Item from Cart API is recommended

Headers

Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : path
Name : The 24 character system-generated cart ID (from the Add Items to Cart or Retrieve Cart by userAuthToken API).
Required: true
Type : requestBody
Name : The item details to be updated.
Required: true

Sample Request

Path:
1
PATCH https://{baseurl}/api-cart/cart/607f8a8f0118960009a8e6ee/items
Copied!
Request Body:
1
{
2
"items": [
3
{
4
"lineItemId": 1,
5
"itemId": 1000000050,
6
"quantity": 10,
7
"price": {
8
"sale": 0,
9
"base": 1000,
10
"discount": {
11
"price": 0,
12
"discountAmount": 0,
13
"promosApplied": []
14
},
15
"currency": "USD"
16
}
17
}
18
]
19
}
Copied!

Sample Response

Success Code: 200
Message: OK
Description: You'll see this message when the cart is successfully updated.
1
{
2
"_id": "607f8a8f0118960009a8e6ee",
3
"deleted": false,
4
"registeredUser": true,
5
"cartId": 1475,
6
"items": [
7
{
8
"price": {
9
"discount": {
10
"discountAmount": 0,
11
"price": 0,
12
"promosApplied": []
13
},
14
"sale": 0,
15
"base": 900,
16
"currency": "USD"
17
},
18
"sample": false,
19
"discountedQuantity": 0,
20
"group": [
21
"123123123123123213212222"
22
],
23
"weightUnit": "lb",
24
"isPickup": false,
25
"createdAt": "2021-04-21T02:14:38.620Z",
26
"updatedAt": "2021-04-21T18:04:12.902Z",
27
"_id": "607f8a8f0118960009a8e6ef",
28
"itemId": 1000000051,
29
"quantity": 3,
30
"priceListId": 100269,
31
"sku": "1538910",
32
"taxCode": "PH060771",
33
"title": "Luminous Cushion Lagoon",
34
"weight": 1,
35
"lineItemId": 1,
36
"attributeTotalPrice": 0,
37
"totalPrice": {
38
"currency": "USD",
39
"amount": 2700
40
},
41
"attributes": [],
42
"id": "607f8a8f0118960009a8e6ef"
43
},
44
{
45
"price": {
46
"discount": {
47
"discountAmount": 0,
48
"price": 0,
49
"promosApplied": []
50
},
51
"sale": 48,
52
"base": 148,
53
"currency": "USD"
54
},
55
"sample": false,
56
"discountedQuantity": 0,
57
"group": [
58
"123123123123123213212222"
59
],
60
"weightUnit": "lb",
61
"isPickup": false,
62
"createdAt": "2021-04-21T02:14:38.620Z",
63
"updatedAt": "2021-04-21T18:04:12.902Z",
64
"_id": "607f8a8f0118960009a8e6f0",
65
"itemId": 1000000052,
66
"quantity": 2,
67
"priceListId": 100269,
68
"sku": "1583908",
69
"taxCode": "PH060771",
70
"title": "Embellished Pillow Pink",
71
"weight": 1,
72
"lineItemId": 2,
73
"attributeTotalPrice": 0,
74
"totalPrice": {
75
"currency": "USD",
76
"amount": 96
77
},
78
"attributes": [],
79
"id": "607f8a8f0118960009a8e6f0"
80
}
81
],
82
"userId": "600a56593245200007982fac",
83
"allPromosApplied": [],
84
"attributes": [],
85
"createdAt": "2021-04-21T02:14:39.048Z",
86
"updatedAt": "2021-04-21T18:04:12.932Z",
87
"__v": 0,
88
"totalAmount": {
89
"currency": "USD",
90
"amount": 2796
91
},
92
"quantity": 5,
93
"errors": {
94
"inventory": [],
95
"price": [
96
{
97
"_id": "60133c1d93dfc60007ec11d7",
98
"priceListId": 100269,
99
"itemId": 1000000051,
100
"offers": [
101
{
102
"price": {
103
"sale": 0,
104
"cost": 580,
105
"currency": "USD",
106
"base": 900,
107
"discount": {
108
"discountAmount": 0,
109
"price": 0,
110
"promosApplied": []
111
}
112
},
113
"_id": "605b8623dbdb92000746d766",
114
"kind": null,
115
"channel": 12,
116
"startDate": "2021-03-24T19:15:00.000Z",
117
"endDate": "2100-01-01T07:59:00.000Z",
118
"offerCode": 4166800
119
}
120
]
121
}
122
],
123
"promo": []
124
}
125
}
Copied!
Error Code: 404
Message: Not found
Description: You will see this error when the specified cart ID doesn't exist in the system.
1
{
2
"code": "CART_NOT_FOUND",
3
"message": "Cart not found."
4
}
Copied!
Error Code: 400
Message: Request validation
Description: You will see this error when the specified cart ID is lesser or greater than 24 characters.
1
{
2
"code": "REQUEST_VALIDATION",
3
"message": "Invalid data in path: /cartId should NOT be shorter than 24 characters"
4
}
Copied!
Error Code: 500
Message: Forbidden
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).
1
{
2
"message": "Forbidden"
3
}
Copied!
Error Code: 500
Message: Internal Server Error
Description: You will see this error when the item to be updated is already in cart with a different lineItemId.
1
{
2
"message": "Cannot read property 'attributes' of undefined"
3
}
Copied!
Error Code: 500
Message: Internal Server Error
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Change Log

  • June - 2021
  • July - 2020 First updated
Last modified 1mo ago
Copy link
Contents
Change Log