XM
Members
Remove Promo
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
PATCH https://{baseurl}/api-cart/cart/remove-promo
Copied!
Removing a promotional code is as easy as it is adding them. This API facilitates removal of promotional code, at any stage before the billing is completed.

Headers

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

Parameters

Type : requestBody
Name : The 24 character system-generated cart ID (from the Add Items to Cart or Retrieve Cart by Authorization Token API) and the promo ID.
Required: true

Sample Request

Path:
1
PATCH https://{baseurl}/api-cart/cart/remove-promo
Copied!
Request Body:
1
2
{
3
"cartId": "607f8a8f0118960009a8e6ee",
4
"promoId": "605b821da953e9000759f735"
5
}
Copied!

Response

Success Code: 200
Message: OK
Description: You'll see this message when the promo is successfully applied.
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:47:46.423Z",
27
"_id": "607f8a8f0118960009a8e6ef",
28
"itemId": 1000000051,
29
"quantity": 4,
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": 3600
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:47:46.424Z",
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:47:46.463Z",
87
"__v": 0,
88
"totalAmount": {
89
"currency": "USD",
90
"amount": 3696
91
},
92
"quantity": 6,
93
"errors": {
94
"inventory": [],
95
"price": [],
96
"promo": []
97
}
98
}
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: 400
Message: Bad Request
Description: You will see this error when the promo doesn't exist in the system.
1
{
2
"code": "PROMO_NOT_FOUND",
3
"message": "605b821da953e9000759f735 not found."
4
}
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