For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
5% off for non-VIP customers (including guest customers, and registered customers who are not assigned to any groups, and registered customers who are assigned to a non-VIP group)
Request
Response
Example request
{
"name": "5% off for non-VIP customers",
"redemption_type": "AUTOMATIC",
"customer": {
"excluded_group_ids": [
1
]
},
"rules": [
{
"action": {
"cart_value": {
"discount": {
"percentage_amount": "5"
}
}
}
}
]
}
3% off for guest customers or customers not assigned to any group
Request
Response
Example request
1
{
2
"name": "3% off for guest customers or customers not assigned to any group",
3
"redemption_type": "AUTOMATIC",
4
"customer": {
5
"group_ids": [
6
0
7
]
8
},
9
"rules": [
10
{
11
"action": {
12
"cart_value": {
13
"discount": {
14
"percentage_amount": "3"
15
}
16
}
17
}
18
}
19
]
20
}
10% off for customers with total order count of 10 or more
Request
Response
Example request
1
{
2
"name": "10% off for customers with total order count of 10 or more",
3
"redemption_type": "AUTOMATIC",
4
"customer": {
5
"minimum_order_count": 10
6
},
7
"rules": [
8
{
9
"action": {
10
"cart_value": {
11
"discount": {
12
"percentage_amount": "10"
13
}
14
}
15
}
16
}
17
]
18
}
10% off for customers who belong to segment 1 or segment 2 (Closed Beta)
Request
Response
Example request
1
{
2
"name": "10% off for customers who belong to segment 1 or segment 2",
3
"redemption_type": "AUTOMATIC",
4
"customer": {
5
"segments": {
6
"isd": [
7
"61fd72bc-7400-4a7b-ac64-96c0d315c464",
8
"d52fb39d-6715-430e-a0bf-21a192d790f0"
9
]
10
}
11
},
12
"rules": [
13
{
14
"action": {
15
"cart_value": {
16
"discount": {
17
"percentage_amount": "10"
18
}
19
}
20
}
21
}
22
]
23
}
10% off for customers who do NOT belong to segment 1, including those who do not belong to any segments(Closed Beta)
Request
Response
Example request
1
{
2
"name": "10% off for customers who do not belong to segment 1",
3
"redemption_type": "AUTOMATIC",
4
"customer": {
5
"segments": {
6
"not": {
7
"id": [
8
"61fd72bc-7400-4a7b-ac64-96c0d315c464"
9
]
10
}
11
}
12
},
13
"rules": [
14
{
15
"action": {
16
"cart_value": {
17
"discount": {
18
"percentage_amount": "10"
19
}
20
}
21
}
22
}
23
]
24
}
10% off for customers who belong to segment 1 and segment 2 (Closed Beta)
Request
Response
Example request
1
{
2
"name": "10% off for customers who belong to segment 1 and segment 2",
3
"redemption_type": "AUTOMATIC",
4
"customer": {
5
"segments": {
6
"and": [
7
{
8
"id": ["61fd72bc-7400-4a7b-ac64-96c0d315c464"]
9
},
10
{
11
"id": ["d52fb39d-6715-430e-a0bf-21a192d790f0"]
12
}
13
]
14
}
15
},
16
"rules": [
17
{
18
"action": {
19
"cart_value": {
20
"discount": {
21
"percentage_amount": "10"
22
}
23
}
24
}
25
}
26
]
27
}
10% off for customers who belong to segment 3 or customers who belong to segment 1 and segment 2 (Closed Beta)
Request
Response
Example request
1
{
2
"name": "10% off for customers who belong to segment 3 or customers who belong to segment 1 and segment 2",