Retrieve a List of Promotions

Path:
1
POST https://{baseurl}/api-price/promo
Copied!
Enables you to retrieve all the active promotions, in a paginated response. Optionally, query parameters 'limit'  and 'offset' can be specified to narrow down results.
Headers
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
Parameters: 
Type: query
Name: The offset and limit values to retrieve the list of promotions, in a paginated response. The default value for offset and limit are 0 and 10, respectively. 
Required: true
Sample Response
HTTP Code: 200
Message: OK
1
{
2
    "query": {
3
        "limit": 10,
4
        "offset": 0,
5
        "count": 66
6
    },
7
    "promos": [
8
        {
9
            "_id": "5fc8aedcdf91700008c62918",
10
            "state": "ACTIVE",
11
            "isImplicit": false,
12
            "isExclusive": false,
13
            "title": "HURRY",
14
            "startDate": "2020-12-03T09:30:00.965Z",
15
            "endDate": "2020-12-03T18:30:00.000Z",
16
            "promo": [
17
                {
18
                    "condition": [
19
                        "5fc8aedcdf91700008c62917"
20
                    ],
21
                    "discount": [
22
                        {
23
                            "_id": "5fc8b7909b145200083018d2",
24
                            "unit": "%OFF",
25
                            "value": 10,
26
                            "ON": {
27
                                "kind": "SKU",
28
                                "value": null
29
                            }
30
                        }
31
                    ],
32
                    "targetProducts": [
33
                        {
34
                            "kind": "SKU",
35
                            "value": "*",
36
                            "operator": "IN"
37
                        }
38
                    ]
39
                }
40
            ],
41
            "extra": {
42
                "promoTiers": [
43
                    {
44
                        "id": 0,
45
                        "buyValue": "",
46
                        "typeWithValues": {
47
                            "selectedPromotionType": "Percentage off",
48
                            "promotionTypeValue": "10",
49
                            "shippingPromotionTypeValue": "",
50
                            "selectedShippingType": "Ground",
51
                            "selectedShippingPromotionType": "Percentage off"
52
                        }
53
                    }
54
                ],
55
                "categoriesPath": {},
56
                "selectedPriceRadio": "Base price",
57
                "selectedPromoTypeRadio": "SKU(s)",
58
                "getYSameSku": null,
59
                "buyXSameSku": null,
60
                "targetType": "targetX",
61
                "selectedAdvancedOption": "SAME_SKUS",
62
                "userKind": "All",
63
                "target": {
64
                    "types": {
65
                        "targetX": {
66
                            "selectedSkus": {},
67
                            "selectedCategories": {},
68
                            "products": [],
69
                            "radioId": "ALL_PRODUCTS",
70
                            "skusCount": 0,
71
                            "selectedAttributesTree": {},
72
                            "selectedAttributes": [],
73
                            "totalProductsCount": 0,
74
                            "categoriesSkusCount": 0
75
                        }
76
                    }
77
                },
78
                "isAdvanceOptionsOpen": false,
79
                "selectedExplicitOption": "isMultiple"
80
            },
81
            "promoId": 1281,
82
            "termsAndConditions": [],
83
            "updatedAt": "2020-12-03T10:01:52.415Z",
84
            "promoCodes": [
85
                "HURRY"
86
            ],
87
            "promoCount": 1
88
        },
89
        {
90
            "_id": "5fc8aec4df91700008c62915",
91
            "state": "EXPIRED",
92
            "isImplicit": false,
93
            "isExclusive": true,
94
            "title": "HURRY_DELETED",
95
            "startDate": "2020-12-01T09:30:00.118Z",
96
            "endDate": "2020-12-01T18:30:00.000Z",
97
            "promo": [
98
                {
99
                    "condition": [
100
                        "5fc8aec4df91700008c62914"
101
                    ],
102
                    "discount": [
103
                        {
104
                            "_id": "5fc8aec4df91700008c62916",
105
                            "unit": "%OFF",
106
                            "value": 10,
107
                            "ON": {
108
                                "kind": "SKU",
109
                                "value": null
110
                            }
111
                        }
112
                    ],
113
                    "targetProducts": [
114
                        {
115
                            "kind": "SKU",
116
                            "value": "*",
117
                            "operator": "IN"
118
                        }
119
                    ]
120
                }
121
            ],
122
            "extra": {
123
                "promoTiers": [
124
                    {
125
                        "id": 0,
126
                        "buyValue": "",
127
                        "typeWithValues": {
128
                            "selectedPromotionType": "Percentage off",
129
                            "promotionTypeValue": "10",
130
                            "shippingPromotionTypeValue": "",
131
                            "selectedShippingType": "Ground",
132
                            "selectedShippingPromotionType": "Percentage off"
133
                        }
134
                    }
135
                ],
136
                "selectedPriceRadio": "Base price",
137
                "selectedPromoTypeRadio": "SKU(s)",
138
                "getYSameSku": null,
139
                "buyXSameSku": null,
140
                "targetType": "targetX",
141
                "selectedAdvancedOption": "SAME_SKUS",
142
                "userKind": "All",
143
                "target": {
144
                    "types": {
145
                        "targetX": {
146
                            "products": [],
147
                            "radioId": "ALL_PRODUCTS",
148
                            "skusCount": 0,
149
                            "selectedAttributes": [],
150
                            "totalProductsCount": 0,
151
                            "categoriesSkusCount": 0
152
                        }
153
                    }
154
                },
155
                "isAdvanceOptionsOpen": false,
156
                "selectedExplicitOption": "isMultiple"
157
            },
158
            "promoId": 1280,
159
            "termsAndConditions": [],
160
            "updatedAt": "2020-12-03T09:24:20.136Z",
161
            "promoCodes": [
162
                "HURRY_DELETED"
163
            ],
164
            "promoCount": 1
165
        },
166
        {
167
            "_id": "5fc8ad76969f071ff85221e2",
168
            "state": "ACTIVE",
169
            "isImplicit": false,
170
            "isExclusive": true,
171
            "title": "Sunday Special Coupon",
172
            "startDate": "2020-12-01T11:58:42.860Z",
173
            "endDate": "2020-12-05T08:19:33.453Z",
174
            "promo": [
175
                {
176
                    "condition": [
177
                        "5fc8ad75969f071ff85221e1"
178
                    ],
179
                    "discount": [
180
                        {
181
                            "_id": "5fc8ad76969f071ff85221e3",
182
                            "unit": "%OFF",
183
                            "value": 10,
184
                            "ON": {
185
                                "kind": "SKU",
186
                                "value": null
187
                            }
188
                        }
189
                    ],
190
                    "targetProducts": [
191
                        {
192
                            "kind": "SKU",
193
                            "value": "*",
194
                            "operator": "IN"
195
                        }
196
                    ]
197
                }
198
            ],
199
            "termsAndConditions": [
200
                {
201
                    "_id": "5fc8ad76969f071ff85221e4",
202
                    "title": "Entering a Coupon",
203
                    "description": "Each coupon is identified by a code and has different rewards. The claimant can decide the reward desired during the booking phase whilst being bound by the conditions linked to the redemption of the coupon"
204
                }
205
            ],
206
            "promoId": 1279,
207
            "updatedAt": "2020-12-03T09:18:46.956Z",
208
            "promoCodes": [
209
                "SUND56AY"
210
            ],
211
            "promoCount": 1
212
        },
213
        {
214
            "_id": "5fc89d244f0a410007018dc4",
215
            "state": "ACTIVE",
216
            "isImplicit": false,
217
            "isExclusive": false,
218
            "title": "test71",
219
            "startDate": "2020-12-03T08:30:00.000Z",
220
            "endDate": "2020-12-03T18:30:00.000Z",
221
            "promo": [
222
                {
223
                    "condition": [
224
                        "5fc89d244f0a410007018dc3"
225
                    ],
226
                    "discount": [
227
                        {
228
                            "_id": "5fc89d7bdbcf140007196545",
229
                            "unit": "%OFF",
230
                            "value": 20,
231
                            "ON": {
232
                                "kind": "SKU",
233
                                "value": null
234
                            }
235
                        }
236
                    ],
237
                    "targetProducts": [
238
                        {
239
                            "kind": "SKU",
240
                            "value": "*",
241
                            "operator": "IN"
242
                        }
243
                    ]
244
                }
245
            ],
246
            "extra": {
247
                "promoTiers": [
248
                    {
249
                        "id": 0,
250
                        "buyValue": "",
251
                        "typeWithValues": {
252
                            "selectedPromotionType": "Percentage off",
253
                            "promotionTypeValue": "20",
254
                            "shippingPromotionTypeValue": "",
255
                            "selectedShippingType": "Ground",
256
                            "selectedShippingPromotionType": "Percentage off"
257
                        }
258
                    }
259
                ],
260
                "categoriesPath": {},
261
                "selectedPriceRadio": "Base price",
262
                "selectedPromoTypeRadio": "SKU(s)",
263
                "getYSameSku": null,
264
                "buyXSameSku": null,
265
                "targetType": "targetX",
266
                "selectedAdvancedOption": "SAME_SKUS",
267
                "userKind": "All",
268
                "target": {
269
                    "types": {
270
                        "targetX": {
271
                            "selectedSkus": {},
272
                            "selectedCategories": {},
273
                            "products": [],
274
                            "radioId": "ALL_PRODUCTS",
275
                            "skusCount": 0,
276
                            "selectedAttributesTree": {},
277
                            "selectedAttributes": [],
278
                            "totalProductsCount": 0,
279
                            "categoriesSkusCount": 0
280
                        }
281
                    }
282
                },
283
                "isAdvanceOptionsOpen": false,
284
                "selectedExplicitOption": "isMultiple"
285
            },
286
            "promoId": 1270,
287
            "termsAndConditions": [],
288
            "updatedAt": "2020-12-03T08:10:35.869Z",
289
            "promoCodes": [
290
                "testting71"
291
            ],
292
            "promoCount": 1
293
        },
294
        {
295
            "_id": "5fc0e18c57d2870008576aeb",
296
            "state": "ACTIVE",
297
            "isImplicit": false,
298
            "isExclusive": false,
299
            "title": "checkAttribute",
300
            "startDate": "2020-11-24T18:30:00.000Z",
301
            "endDate": "2021-11-11T11:30:00.000Z",
302
            "promo": [
303
                {
304
                    "condition": [
305
                        "5fc0e18c57d2870008576aea"
306
                    ],
307
                    "discount": [
308
                        {
309
                            "_id": "5fc88e4a02aeba00084110a0",
310
                            "unit": "%OFF",
311
                            "value": 20,
312
                            "ON": {
313
                                "kind": "SKU",
314
                                "value": null
315
                            }
316
                        }
317
                    ],
318
                    "targetProducts": [
319
                        {
320
                            "kind": "SKU",
321
                            "value": "*",
322
                            "operator": "IN"
323
                        }
324
                    ]
325
                },
326
                {
327
                    "condition": [
328
                        "5fc88e4a02aeba000841109f"
329
                    ],
330
                    "discount": [
331
                        {
332
                            "_id": "5fc88e4a02aeba00084110a1",
333
                            "unit": "%OFF",
334
                            "value": 40,
335
                            "ON": {
336
                                "kind": "SKU",
337
                                "value": null
338
                            }
339
                        }
340
                    ],
341
                    "targetProducts": [
342
                        {
343
                            "kind": "SKU",
344
                            "value": "*",
345
                            "operator": "IN"
346
                        }
347
                    ]
348
                }
349
            ],
350
            "extra": {
351
                "promoTiers": [
352
                    {
353
                        "id": 0,
354
                        "buyValue": 10,
355
                        "typeWithValues": {
356
                            "selectedPromotionType": "Percentage off",
357
                            "promotionTypeValue": "20",
358
                            "shippingPromotionTypeValue": "",
359
                            "selectedShippingType": "Ground",
360
                            "selectedShippingPromotionType": "Percentage off"
361
                        }
362
                    },
363
                    {
364
                        "id": 1,
365
                        "typeWithValues": {
366
                            "selectedPromotionType": "Percentage off",
367
                            "promotionTypeValue": "40",
368
                            "shippingPromotionTypeValue": "",
369
                            "selectedShippingType": "Ground",
370
                            "selectedShippingPromotionType": "Percentage off"
371
                        },
372
                        "buyValue": 40
373
                    }
374
                ],
375
                "categoriesPath": {},
376
                "selectedPriceRadio": "Base price",
377
                "selectedPromoTypeRadio": "Cart Value",
378
                "getYSameSku": null,
379
                "buyXSameSku": null,
380
                "targetType": "targetX",
381
                "selectedAdvancedOption": "SAME_SKUS",
382
                "userKind": "All",
383
                "target": {
384
                    "types": {
385
                        "targetX": {
386
                            "selectedSkus": {},
387
                            "selectedCategories": {},
388
                            "products": [],
389
                            "radioId": "ALL_PRODUCTS",
390
                            "skusCount": 0,
391
                            "selectedAttributesTree": {},
392
                            "selectedAttributes": [],
393
                            "totalProductsCount": 0,
394
                            "categoriesSkusCount": 0,
395
                            "attributesItemDetails": {}
396
                        }
397
                    }
398
                },
399
                "isAdvanceOptionsOpen": false,
400
                "selectedExplicitOption": "isMultiple"
401
            },
402
            "promoId": 1267,
403
            "updatedAt": "2020-12-03T07:05:46.362Z",
404
            "promoCodes": [
405
                "checkAttribute"
406
            ],
407
            "promoCount": 1
408
        },
409
        {
410
            "_id": "5fbe4d198ac49a00071560ca",
411
            "state": "EXPIRED",
412
            "isImplicit": false,
413
            "isExclusive": true,
414
            "title": "non stack",
415
            "startDate": "2020-11-25T12:30:00.904Z",
416
            "endDate": "2020-12-02T18:30:00.000Z",
417
            "promo": [
418
                {
419
                    "condition": [
420
                        "5fbe4d198ac49a00071560c9"
421
                    ],
422
                    "discount": [
423
                        {
424
                            "_id": "5fbf9c8323cb0000079d27b1",
425
                            "unit": "AMOUNT_OFF",
426
                            "value": 20,
427
                            "ON": {
428
                                "kind": "SKU",
429
                                "value": null
430
                            }
431
                        }
432
                    ],
433
                    "targetProducts": [
434
                        {
435
                            "kind": "SKU",
436
                            "value": "*",
437
                            "operator": "IN"
438
                        }
439
                    ]
440
                }
441
            ],
442
            "extra": {
443
                "promoTiers": [
444
                    {
445
                        "id": 0,
446
                        "buyValue": "",
447
                        "typeWithValues": {
448
                            "selectedPromotionType": "Amount off",
449
                            "promotionTypeValue": "20",
450
                            "shippingPromotionTypeValue": "",
451
                            "selectedShippingType": "Ground",
452
                            "selectedShippingPromotionType": "Percentage off"
453
                        }
454
                    }
455
                ],
456
                "categoriesPath": {},
457
                "selectedPriceRadio": "Base price",
458
                "selectedPromoTypeRadio": "SKU(s)",
459
                "getYSameSku": null,
460
                "buyXSameSku": null,
461
                "targetType": "targetX",
462
                "selectedAdvancedOption": "SAME_SKUS",
463
                "userKind": "All",
464
                "target": {
465
                    "types": {
466
                        "targetX": {
467
                            "selectedSkus": {},
468
                            "selectedCategories": {},
469
                            "products": [],
470
                            "radioId": "ALL_PRODUCTS",
471
                            "skusCount": 0,
472
                            "selectedAttributesTree": {},
473
                            "selectedAttributes": [],
474
                            "totalProductsCount": 0,
475
                            "categoriesSkusCount": 0
476
                        }
477
                    }
478
                },
479
                "isAdvanceOptionsOpen": false,
480
                "selectedExplicitOption": "isMultiple"
481
            },
482
            "promoId": 1262,
483
            "updatedAt": "2020-11-26T12:16:03.897Z",
484
            "promoCodes": [
485
                "dddddddd"
486
            ],
487
            "promoCount": 1
488
        },
489
        {
490
            "_id": "5fa0128f5d09be00070d03ff",
491
            "state": "EXPIRED",
492
            "isImplicit": false,
493
            "isExclusive": false,
494
            "title": "BUY X GET 2 inclusion coupon",
495
            "startDate": "2020-11-01T14:15:00.159Z",
496
            "endDate": "2020-11-30T14:30:00.000Z",
497
            "promo": [
498
                {
499
                    "condition": [
500
                        "5fa0128f5d09be00070d03fe"
501
                    ],
502
                    "discount": [
503
                        {
504
                            "_id": "5fbf73cae8f3170008766842",
505
                            "unit": "%OFF",
506
                            "value": 50,
507
                            "ON": {
508
                                "kind": "SKU",
509
                                "quantity": 2,
510
                                "value": null
511
                            }
512
                        }
513
                    ],
514
                    "targetProducts": [
515
                        {
516
                            "kind": "SKU",
517
                            "value": "*",
518
                            "operator": "IN"
519
                        }
520
                    ]
521
                }
522
            ],
523
            "extra": {
524
                "promoTiers": [
525
                    {
526
                        "id": 0,
527
                        "buyValue": "",
528
                        "typeWithValues": {
529
                            "selectedPromotionType": "Percentage off",
530
                            "promotionTypeValue": "50",
531
                            "shippingPromotionTypeValue": "",
532
                            "selectedShippingType": "Ground",
533
                            "selectedShippingPromotionType": "Percentage off"
534
                        }
535
                    }
536
                ],
537
                "categoriesPath": {
538
                    "5f8936277b54060007c50a6e": "5f8936277b54060007c50a6e",
539
                    "5f96795ddecace000887afd3": "5f8936277b54060007c50a6e.5f96795ddecace000887afd3",
540
                    "5f887404fedf27000810fd3a": "5f887404fedf27000810fd3a",
541
                    "5f968dbe5648730008d8d346": "5f887404fedf27000810fd3a.5f968c925648730008d8d345.5f968dbe5648730008d8d346",
542
                    "5f968c925648730008d8d345": "5f887404fedf27000810fd3a.5f968c925648730008d8d345",
543
                    "5f90106acf29b600085acd3f": "5f887404fedf27000810fd3a.5f90106acf29b600085acd3f",
544
                    "5f7dc272c48da000081b9416": "5f7dc272c48da000081b9416",
545
                    "5f7dc27cc48da000081b9419": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc27cc48da000081b9419",
546
                    "5f7dc282c48da000081b941b": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc282c48da000081b941b",
547
                    "5f7dc28bc48da000081b941d": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc280c48da000081b941a.5f7dc28bc48da000081b941d",
548
                    "5f7dc289c48da000081b941c": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc280c48da000081b941a.5f7dc289c48da000081b941c",
549
                    "5f7dc280c48da000081b941a": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc280c48da000081b941a",
550
                    "5f7dc279c48da000081b9418": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418",
551
                    "5f7dc276c48da000081b9417": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417",
552
                    "5f7d8d4373aeb500077048dc": "5f7d8d4373aeb500077048dc",
553
                    "5f7d8d5b73aeb500077048de": "5f7d8d4373aeb500077048dc.5f7d8d5073aeb500077048dd.5f7d8d5b73aeb500077048de",
554
                    "5f7d8d5073aeb500077048dd": "5f7d8d4373aeb500077048dc.5f7d8d5073aeb500077048dd",
555
                    "5f7d8541f2ea3f0007a68e54": "5f7d8541f2ea3f0007a68e54",
556
                    "5f7d86baf2ea3f0007a68e58": "5f7d8541f2ea3f0007a68e54.5f7d85aff2ea3f0007a68e56.5f7d86baf2ea3f0007a68e58",
557
                    "5f7d85aff2ea3f0007a68e56": "5f7d8541f2ea3f0007a68e54.5f7d85aff2ea3f0007a68e56",
558
                    "5f5766860f5d2f0007a378a9": "5f5766860f5d2f0007a378a9",
559
                    "5faa325bcffc7900072a83e5": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa325bcffc7900072a83e5",
560
                    "5faa3252cffc7900072a83e4": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3252cffc7900072a83e4",
561
                    "5faa324bcffc7900072a83e3": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa324bcffc7900072a83e3",
562
                    "5faa3270cffc7900072a83e7": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3247cffc7900072a83e2.5faa3270cffc7900072a83e7",
563
                    "5faa3269cffc7900072a83e6": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3247cffc7900072a83e2.5faa3269cffc7900072a83e6",
564
                    "5faa3247cffc7900072a83e2": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3247cffc7900072a83e2",
565
                    "5faa3220cffc7900072a83e1": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1",
566
                    "5faa37fb41eae10008886585": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37ea41eae10008886583.5faa37f641eae10008886584.5faa37fb41eae10008886585",
567
                    "5faa37f641eae10008886584": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37ea41eae10008886583.5faa37f641eae10008886584",
568
                    "5faa37ea41eae10008886583": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37ea41eae10008886583",
569
                    "5faa37de41eae10008886582": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37de41eae10008886582",
570
                    "5faa37cc41eae10008886581": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581",
571
                    "5f5766970f5d2f0007a378ac": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5f5766900f5d2f0007a378ab.5f5766970f5d2f0007a378ac",
572
                    "5f5766900f5d2f0007a378ab": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5f5766900f5d2f0007a378ab",
573
                    "5f57668c0f5d2f0007a378aa": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa",
574
                    "5f55df5adab45500080f92f2": "5f55df5adab45500080f92f2",
575
                    "5f55df69dab45500080f92f5": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df69dab45500080f92f5",
576
                    "5f5f79c96ff31800075fca35": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4.5f5766820f5d2f0007a378a8.5f5f79c96ff31800075fca35",
577
                    "5f5766820f5d2f0007a378a8": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4.5f5766820f5d2f0007a378a8",
578
                    "5f55df6fdab45500080f92f6": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4.5f55df6fdab45500080f92f6",
579
                    "5f55df65dab45500080f92f4": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4",
580
                    "5f55df61dab45500080f92f3": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3",
581
                    "5f55be4209402a0008e5e46d": "5f55be4209402a0008e5e46d",
582
                    "5f51ed3fb1d96600084b57bf": "5f51ed3fb1d96600084b57bf",
583
                    "5f51ed29b1d96600084b57bd": "5f51ed29b1d96600084b57bd",
584
                    "5f51ed39b1d96600084b57be": "5f51ed29b1d96600084b57bd.5f51ed39b1d96600084b57be",
585
                    "5f4f5476e197910007cc541b": "5f4f5476e197910007cc541b",
586
                    "5f4f5487e197910007cc541e": "5f4f5476e197910007cc541b.5f4f547be197910007cc541c.5f4f5481e197910007cc541d.5f4f5487e197910007cc541e",
587
                    "5f4f5481e197910007cc541d": "5f4f5476e197910007cc541b.5f4f547be197910007cc541c.5f4f5481e197910007cc541d",
588
                    "5f4f547be197910007cc541c": "5f4f5476e197910007cc541b.5f4f547be197910007cc541c",
589
                    "5f4cd53194cace0008f0a67d": "5f4cd53194cace0008f0a67d",
590
                    "5f4cb801b880ef0007172b5b": "5f4cb801b880ef0007172b5b",
591
                    "5f4cb904b880ef0007172b5e": "5f4cb801b880ef0007172b5b.5f4cb806b880ef0007172b5c.5f4cb80ab880ef0007172b5d.5f4cb904b880ef0007172b5e",
592
                    "5f4cb80ab880ef0007172b5d": "5f4cb801b880ef0007172b5b.5f4cb806b880ef0007172b5c.5f4cb80ab880ef0007172b5d",
593
                    "5f4cb806b880ef0007172b5c": "5f4cb801b880ef0007172b5b.5f4cb806b880ef0007172b5c",
594
                    "5f32a3107e7e200007746de0": "5f32a3107e7e200007746de0",
595
                    "5f92aa061a238700082946ee": "5f32a3107e7e200007746de0.5f92aa061a238700082946ee"
596
                },
597
                "selectedPriceRadio": "Base price",
598
                "selectedPromoTypeRadio": "SKU(s)",
599
                "getYSameSku": "2",
600
                "buyXSameSku": "1",
601
                "targetType": "targetY",
602
                "selectedAdvancedOption": "SAME_SKUS",
603
                "userKind": "All",
604
                "target": {
605
                    "types": {
606
                        "targetX": {
607
                            "selectedSkus": {},
608
                            "selectedCategories": {},
609
                            "products": [],
610
                            "radioId": "ALL_PRODUCTS",
611
                            "skusCount": 0,
612
                            "selectedAttributesTree": {},
613
                            "selectedAttributes": [],
614
                            "totalProductsCount": 0,
615
                            "categoriesSkusCount": 0,
616
                            "attributesItemDetails": {}
617
                        }
618
                    }
619
                },
620
                "isAdvanceOptionsOpen": true,
621
                "selectedExplicitOption": "isMultiple"
622
            },
623
            "promoId": 1159,
624
            "updatedAt": "2020-11-26T09:22:18.187Z",
625
            "promoCodes": [
626
                "BOGOINCLUSION"
627
            ],
628
            "promoCount": 1
629
        },
630
        {
631
            "_id": "5fb674f0c076e60008b172e3",
632
            "state": "DISABLED",
633
            "isImplicit": false,
634
            "isExclusive": true,
635
            "title": "PostmanConfigTestingCoupon",
636
            "startDate": "2020-11-19T13:45:00.703Z",
637
            "endDate": "2020-11-19T14:00:00.704Z",
638
            "promo": [
639
                {
640
                    "condition": [
641
                        "5fb674f0c076e60008b172e2"
642
                    ],
643
                    "discount": [
644
                        {
645
                            "_id": "5fb674f0c076e60008b172e4",
646
                            "unit": "%OFF",
647
                            "value": 10,
648
                            "ON": {
649
                                "kind": "SKU",
650
                                "value": null
651
                            }
652
                        }
653
                    ],
654
                    "targetProducts": [
655
                        {
656
                            "kind": "SKU",
657
                            "value": "*",
658
                            "operator": "IN"
659
                        }
660
                    ]
661
                }
662
            ],
663
            "extra": {
664
                "promoTiers": [
665
                    {
666
                        "id": 0,
667
                        "buyValue": 1000,
668
                        "typeWithValues": {
669
                            "selectedPromotionType": "Percentage off",
670
                            "promotionTypeValue": "10",
671
                            "shippingPromotionTypeValue": "",
672
                            "selectedShippingType": "Ground",
673
                            "selectedShippingPromotionType": "Percentage off"
674
                        }
675
                    }
676
                ],
677
                "selectedPriceRadio": "Base price",
678
                "selectedPromoTypeRadio": "Cart Value",
679
                "getYSameSku": null,
680
                "buyXSameSku": null,
681
                "targetType": "targetX",
682
                "selectedAdvancedOption": "SAME_SKUS",
683
                "userKind": "All",
684
                "target": {
685
                    "types": {
686
                        "targetX": {
687
                            "products": [],
688
                            "radioId": "ALL_PRODUCTS",
689
                            "skusCount": 0,
690
                            "selectedAttributes": [],
691
                            "totalProductsCount": 0,
692
                            "categoriesSkusCount": 0
693
                        }
694
                    }
695
                },
696
                "isAdvanceOptionsOpen": false,
697
                "selectedExplicitOption": "isMultiple"
698
            },
699
            "promoId": 1244,
700
            "updatedAt": "2020-11-19T13:37:03.708Z",
701
            "promoCodes": [
702
                "PostmanConfigTestingCoupon"
703
            ],
704
            "promoCount": 1
705
        },
706
        {
707
            "_id": "5fa90fb9ce91340008f482ee",
708
            "state": "ACTIVE",
709
            "isImplicit": false,
710
            "isExclusive": false,
711
            "title": "check sku coupon",
712
            "startDate": "2020-10-09T10:00:00.411Z",
713
            "endDate": "2021-03-06T10:00:00.000Z",
714
            "promo": [
715
                {
716
                    "condition": [
717
                        "5fa90fb9ce91340008f482ed"
718
                    ],
719
                    "discount": [
720
                        {
721
                            "_id": "5fb60bd147eb1f0008d600df",
722
                            "unit": "AMOUNT_OFF",
723
                            "value": 40,
724
                            "ON": {
725
                                "kind": "SKU",
726
                                "value": null
727
                            }
728
                        }
729
                    ],
730
                    "targetProducts": [
731
                        {
732
                            "kind": "SKU",
733
                            "value": [
734
                                1000000241
735
                            ],
736
                            "operator": "NOT_IN"
737
                        }
738
                    ]
739
                }
740
            ],
741
            "extra": {
742
                "promoTiers": [
743
                    {
744
                        "id": 0,
745
                        "buyValue": "",
746
                        "typeWithValues": {
747
                            "selectedPromotionType": "Amount off",
748
                            "promotionTypeValue": "40",
749
                            "shippingPromotionTypeValue": "",
750
                            "selectedShippingType": "Ground",
751
                            "selectedShippingPromotionType": "Percentage off"
752
                        }
753
                    }
754
                ],
755
                "categoriesPath": {},
756
                "selectedPriceRadio": "Base price",
757
                "selectedPromoTypeRadio": "SKU(s)",
758
                "getYSameSku": null,
759
                "buyXSameSku": null,
760
                "targetType": "targetX",
761
                "selectedAdvancedOption": "SAME_SKUS",
762
                "userKind": "All",
763
                "target": {
764
                    "types": {
765
                        "targetX": {
766
                            "selectedSkus": {
767
                                "5faa359bdf050d0007e5edf6": {
768
                                    "5faa35a2ff0da80009eee7f2": {
769
                                        "_id": "5faa35a2ff0da80009eee7f2",
770
                                        "title": "dimond ring",
771
                                        "parent": "5faa359bdf050d0007e5edf6",
772
                                        "images": [],
773
                                        "itemId": 1000000241,
774
                                        "sku": "ASDADS"
775
                                    }
776
                                }
777
                            },
778
                            "selectedCategories": {},
779
                            "products": [
780
                                {
781
                                    "key": "SKUs",
782
                                    "values": [
783
                                        {
784
                                            "_id": "5faa35a2ff0da80009eee7f2",
785
                                            "title": "dimond ring",
786
                                            "parent": "5faa359bdf050d0007e5edf6",
787
                                            "images": [],
788
                                            "itemId": 1000000241,
789
                                            "sku": "ASDADS"
790
                                        }
791
                                    ],
792
                                    "count": 1
793
                                }
794
                            ],
795
                            "radioId": "EXCLUDE_PRODUCTS",
796
                            "skusCount": 1,
797
                            "selectedAttributesTree": {},
798
                            "selectedAttributes": [],
799
                            "totalProductsCount": 1,
800
                            "categoriesSkusCount": 0,
801
                            "attributesItemDetails": {}
802
                        }
803
                    }
804
                },
805
                "isAdvanceOptionsOpen": false,
806
                "selectedExplicitOption": "isMultiple"
807
            },
808
            "promoId": 1183,
809
            "updatedAt": "2020-11-19T06:08:17.557Z",
810
            "promoCodes": [
811
                "SKUCOUPON"
812
            ],
813
            "promoCount": 1
814
        },
815
        {
816
            "_id": "5fb60a13580eda0007474634",
817
            "state": "EXPIRED",
818
            "isImplicit": false,
819
            "isExclusive": true,
820
            "title": "asdfadad",
821
            "startDate": "2020-11-19T07:30:00.691Z",
822
            "endDate": "2020-11-19T08:15:00.223Z",
823
            "promo": [
824
                {
825
                    "condition": [
826
                        "5fb60a13580eda0007474633"
827
                    ],
828
                    "discount": [
829
                        {
830
                            "_id": "5fb60a13580eda0007474635",
831
                            "unit": "%OFF",
832
                            "value": 45,
833
                            "ON": {
834
                                "kind": "SKU",
835
                                "quantity": 45,
836
                                "value": null
837
                            }
838
                        }
839
                    ],
840
                    "targetProducts": [
841
                        {
842
                            "kind": "CATEGORY",
843
                            "value": [
844
                                "5faa3220cffc7900072a83e1",
845
                                "5faa325bcffc7900072a83e5",
846
                                "5faa3252cffc7900072a83e4",
847
                                "5faa324bcffc7900072a83e3",
848
                                "5faa3247cffc7900072a83e2",
849
                                "5faa3270cffc7900072a83e7",
850
                                "5faa3269cffc7900072a83e6"
851
                            ],
852
                            "operator": "IN"
853
                        }
854
                    ]
855
                }
856
            ],
857
            "extra": {
858
                "promoTiers": [
859
                    {
860
                        "id": 0,
861
                        "buyValue": "",
862
                        "typeWithValues": {
863
                            "selectedPromotionType": "Percentage off",
864
                            "promotionTypeValue": "45",
865
                            "shippingPromotionTypeValue": "",
866
                            "selectedShippingType": "Ground",
867
                            "selectedShippingPromotionType": "Percentage off"
868
                        }
869
                    }
870
                ],
871
                "categoriesPath": {
872
                    "5f8936277b54060007c50a6e": "5f8936277b54060007c50a6e",
873
                    "5f96795ddecace000887afd3": "5f8936277b54060007c50a6e.5f96795ddecace000887afd3",
874
                    "5f887404fedf27000810fd3a": "5f887404fedf27000810fd3a",
875
                    "5f968dbe5648730008d8d346": "5f887404fedf27000810fd3a.5f968c925648730008d8d345.5f968dbe5648730008d8d346",
876
                    "5f968c925648730008d8d345": "5f887404fedf27000810fd3a.5f968c925648730008d8d345",
877
                    "5f90106acf29b600085acd3f": "5f887404fedf27000810fd3a.5f90106acf29b600085acd3f",
878
                    "5f7dc272c48da000081b9416": "5f7dc272c48da000081b9416",
879
                    "5f7dc27cc48da000081b9419": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc27cc48da000081b9419",
880
                    "5f7dc282c48da000081b941b": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc282c48da000081b941b",
881
                    "5f7dc28bc48da000081b941d": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc280c48da000081b941a.5f7dc28bc48da000081b941d",
882
                    "5f7dc289c48da000081b941c": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc280c48da000081b941a.5f7dc289c48da000081b941c",
883
                    "5f7dc280c48da000081b941a": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418.5f7dc280c48da000081b941a",
884
                    "5f7dc279c48da000081b9418": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417.5f7dc279c48da000081b9418",
885
                    "5f7dc276c48da000081b9417": "5f7dc272c48da000081b9416.5f7dc276c48da000081b9417",
886
                    "5f7d8d4373aeb500077048dc": "5f7d8d4373aeb500077048dc",
887
                    "5f7d8d5b73aeb500077048de": "5f7d8d4373aeb500077048dc.5f7d8d5073aeb500077048dd.5f7d8d5b73aeb500077048de",
888
                    "5f7d8d5073aeb500077048dd": "5f7d8d4373aeb500077048dc.5f7d8d5073aeb500077048dd",
889
                    "5f7d8541f2ea3f0007a68e54": "5f7d8541f2ea3f0007a68e54",
890
                    "5f7d86baf2ea3f0007a68e58": "5f7d8541f2ea3f0007a68e54.5f7d85aff2ea3f0007a68e56.5f7d86baf2ea3f0007a68e58",
891
                    "5f7d85aff2ea3f0007a68e56": "5f7d8541f2ea3f0007a68e54.5f7d85aff2ea3f0007a68e56",
892
                    "5f5766860f5d2f0007a378a9": "5f5766860f5d2f0007a378a9",
893
                    "5faa325bcffc7900072a83e5": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa325bcffc7900072a83e5",
894
                    "5faa3252cffc7900072a83e4": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3252cffc7900072a83e4",
895
                    "5faa324bcffc7900072a83e3": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa324bcffc7900072a83e3",
896
                    "5faa3270cffc7900072a83e7": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3247cffc7900072a83e2.5faa3270cffc7900072a83e7",
897
                    "5faa3269cffc7900072a83e6": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3247cffc7900072a83e2.5faa3269cffc7900072a83e6",
898
                    "5faa3247cffc7900072a83e2": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1.5faa3247cffc7900072a83e2",
899
                    "5faa3220cffc7900072a83e1": "5f5766860f5d2f0007a378a9.5faa3220cffc7900072a83e1",
900
                    "5faa37fb41eae10008886585": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37ea41eae10008886583.5faa37f641eae10008886584.5faa37fb41eae10008886585",
901
                    "5faa37f641eae10008886584": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37ea41eae10008886583.5faa37f641eae10008886584",
902
                    "5faa37ea41eae10008886583": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37ea41eae10008886583",
903
                    "5faa37de41eae10008886582": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581.5faa37de41eae10008886582",
904
                    "5faa37cc41eae10008886581": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5faa37cc41eae10008886581",
905
                    "5f5766970f5d2f0007a378ac": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5f5766900f5d2f0007a378ab.5f5766970f5d2f0007a378ac",
906
                    "5f5766900f5d2f0007a378ab": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa.5f5766900f5d2f0007a378ab",
907
                    "5f57668c0f5d2f0007a378aa": "5f5766860f5d2f0007a378a9.5f57668c0f5d2f0007a378aa",
908
                    "5f55df5adab45500080f92f2": "5f55df5adab45500080f92f2",
909
                    "5f55df69dab45500080f92f5": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df69dab45500080f92f5",
910
                    "5f5f79c96ff31800075fca35": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4.5f5766820f5d2f0007a378a8.5f5f79c96ff31800075fca35",
911
                    "5f5766820f5d2f0007a378a8": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4.5f5766820f5d2f0007a378a8",
912
                    "5f55df6fdab45500080f92f6": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4.5f55df6fdab45500080f92f6",
913
                    "5f55df65dab45500080f92f4": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3.5f55df65dab45500080f92f4",
914
                    "5f55df61dab45500080f92f3": "5f55df5adab45500080f92f2.5f55df61dab45500080f92f3",
915
                    "5f55be4209402a0008e5e46d": "5f55be4209402a0008e5e46d",
916
                    "5f51ed3fb1d96600084b57bf": "5f51ed3fb1d96600084b57bf",
917
                    "5f51ed29b1d96600084b57bd": "5f51ed29b1d96600084b57bd",
918
                    "5f51ed39b1d96600084b57be": "5f51ed29b1d96600084b57bd.5f51ed39b1d96600084b57be",
919
                    "5f4f5476e197910007cc541b": "5f4f5476e197910007cc541b",
920
                    "5f4f5487e197910007cc541e": "5f4f5476e197910007cc541b.5f4f547be197910007cc541c.5f4f5481e197910007cc541d.5f4f5487e197910007cc541e",
921
                    "5f4f5481e197910007cc541d": "5f4f5476e197910007cc541b.5f4f547be197910007cc541c.5f4f5481e197910007cc541d",
922
                    "5f4f547be197910007cc541c": "5f4f5476e197910007cc541b.5f4f547be197910007cc541c",
923
                    "5f4cd53194cace0008f0a67d": "5f4cd53194cace0008f0a67d",
924
                    "5f4cb801b880ef0007172b5b": "5f4cb801b880ef0007172b5b",
925
                    "5f4cb904b880ef0007172b5e": "5f4cb801b880ef0007172b5b.5f4cb806b880ef0007172b5c.5f4cb80ab880ef0007172b5d.5f4cb904b880ef0007172b5e",
926
                    "5f4cb80ab880ef0007172b5d": "5f4cb801b880ef0007172b5b.5f4cb806b880ef0007172b5c.5f4cb80ab880ef0007172b5d",
927
                    "5f4cb806b880ef0007172b5c": "5f4cb801b880ef0007172b5b.5f4cb806b880ef0007172b5c",
928
                    "5f32a3107e7e200007746de0": "5f32a3107e7e200007746de0",
929
                    "5f92aa061a238700082946ee": "5f32a3107e7e200007746de0.5f92aa061a238700082946ee"
930
                },
931
                "selectedPriceRadio": "Base price",
932
                "selectedPromoTypeRadio": "SKU(s)",
933
                "getYSameSku": "45",
934
                "buyXSameSku": "45",
935
                "targetType": "targetY",
936
                "selectedAdvancedOption": "DIFFERENT_SKUS",
937
                "userKind": "All",
938
                "target": {
939
                    "types": {
940
                        "targetX": {
941
                            "products": [
942
                                {
943
                                    "key": "Categories",
944
                                    "values": [
945
                                        {
946
                                            "id": "5faa37fb41eae10008886585",
947
                                            "title": "Women / Clothes / newarrival / perfume / brand / rollerball"
948
                                        },
949
                                        {
950
                                            "id": "5faa37de41eae10008886582",
951
                                            "title": "Women / Clothes / newarrival / gold"
952
                                        }
953
                                    ],
954
                                    "count": 2
955
                                }
956
                            ],
957
                            "radioId": "INCLUDE_PRODUCTS",
958
                            "skusCount": 0,
959
                            "selectedAttributes": [],
960
                            "totalProductsCount": 2,
961
                            "categoriesSkusCount": 2
962
                        },
963
                        "targetY": {
964
                            "products": [
965
                                {
966
                                    "key": "Categories",
967
                                    "values": [
968
                                        {
969
                                            "id": "5faa325bcffc7900072a83e5",
970
                                            "title": "Women / Jewellery / Bracelet"
971
                                        },
972
                                        {
973
                                            "id": "5faa3252cffc7900072a83e4",
974
                                            "title": "Women / Jewellery / nosepin"
975
                                        },
976
                                        {
977
                                            "id": "5faa324bcffc7900072a83e3",
978
                                            "title": "Women / Jewellery / chains"
979
                                        },
980
                                        {
981
                                            "id": "5faa3270cffc7900072a83e7",
982
                                            "title": "Women / Jewellery / rings / dimaond"
983
                                        },
984
                                        {
985
                                            "id": "5faa3269cffc7900072a83e6",
986
                                            "title": "Women / Jewellery / rings / gold"
987
                                        }
988
                                    ],
989
                                    "count": 5
990
                                }
991
                            ],
992
                            "radioId": "INCLUDE_PRODUCTS",
993
                            "skusCount": 0,
994
                            "selectedAttributes": [],
995
                            "totalProductsCount": 3,
996
                            "categoriesSkusCount": 3
997
                        }
998
                    }
999
                },
1000
                "isAdvanceOptionsOpen": true,
1001
                "selectedExplicitOption": "isMultiple"
1002
            },
1003
            "promoId": 1239,
1004
            "updatedAt": "2020-11-19T06:00:51.586Z",
1005
            "promoCodes": [
1006
                "asasddas"
1007
            ],
1008
            "promoCount": 1
1009
        }
1010
    ]
1011
}
Copied!
HTTP Code: 400
Message: Client Error
HTTP Code: 500
Message: Server Error
Change Log
June - 2021
March - 2021 First updated
Promotions - Previous
Validate Promotions
Next - Promotions
Retrieve a Single Promotion
Last modified 3mo ago
Copy link
Contents
Change Log