XM
Powered By GitBook
Retrieve a Single Promotion
Path:
1
GET https://{baseurl}/api-price/promo/{promoID}
Copied!
Retrieves details of a single promotion, by promotion ID.

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 promotion ID to retrieve the details of the promotion.
Required: true

Sample Response

HTTP Code: 200 Message: OK
1
{
2
"_id": "5ff58d31358319306ac05349",
3
"promoCodes": [
4
"updatePromoCoad"
5
],
6
"state": "ACTIVE",
7
"isImplicit": false,
8
"isExclusive": false,
9
"title": "bogo update promo",
10
"startDate": "2021-01-06T18:30:00.000Z",
11
"endDate": "2021-01-08T18:30:00.000Z",
12
"type": "PRODUCT",
13
"promo": [
14
{
15
"condition": [
16
{
17
"_id": "5ff58d30358319306ac05348",
18
"operator": "AND",
19
"conditions": [
20
{
21
"value": "*",
22
"operator": "IN",
23
"key": "SKU",
24
"id": null
25
},
26
{
27
"key": "PRICE_KIND",
28
"value": "BASE",
29
"operator": "EQUAL",
30
"id": null
31
},
32
{
33
"key": "QUANTITY",
34
"value": "3",
35
"operator": "GREATER_THAN_OR_EQUAL_TO",
36
"id": null
37
},
38
{
39
"key": "USER_KIND",
40
"value": "ALL",
41
"operator": "EQUAL",
42
"id": null
43
}
44
],
45
"createdAt": "2021-01-06T10:13:04.426Z",
46
"updatedAt": "2021-01-06T10:36:40.787Z",
47
"__v": 0
48
}
49
],
50
"discount": [
51
{
52
"_id": "5ff592b9358319306ac0534c",
53
"unit": "%OFF",
54
"value": 7,
55
"ON": {
56
"kind": "SKU",
57
"quantity": 5,
58
"value": null
59
},
60
"id": "5ff592b9358319306ac0534c"
61
}
62
],
63
"targetProducts": [
64
{
65
"kind": "SKU",
66
"value": "*",
67
"operator": "IN",
68
"id": null
69
}
70
],
71
"id": null
72
}
73
],
74
"extra": {
75
"promoTiers": [
76
{
77
"id": 0,
78
"buyValue": "",
79
"typeWithValues": {
80
"selectedPromotionType": "Percentage off",
81
"promotionTypeValue": "7",
82
"shippingPromotionTypeValue": "",
83
"selectedShippingType": "Ground",
84
"selectedShippingPromotionType": "Percentage off"
85
}
86
}
87
],
88
"categoriesPath": {},
89
"selectedPriceRadio": "Base price",
90
"selectedPromoTypeRadio": "SKU(s)",
91
"getYSameSku": "5",
92
"buyXSameSku": "3",
93
"targetType": "targetX",
94
"selectedAdvancedOption": "SAME_SKUS",
95
"userKind": "All",
96
"target": {
97
"types": {
98
"targetX": {
99
"selectedSkus": {},
100
"selectedCategories": {},
101
"products": [],
102
"radioId": "ALL_PRODUCTS",
103
"skusCount": 0,
104
"selectedAttributesTree": {},
105
"selectedAttributes": [],
106
"totalProductsCount": 0,
107
"categoriesSkusCount": 0,
108
"attributesItemDetails": {}
109
}
110
}
111
},
112
"isAdvanceOptionsOpen": true,
113
"selectedExplicitOption": "isMultiple"
114
},
115
"limits": [],
116
"promoId": 1422,
117
"termsAndConditions": [],
118
"createdAt": "2021-01-06T10:13:05.169Z",
119
"updatedAt": "2021-01-06T10:36:41.038Z",
120
"__v": 0
121
}
Copied!
HTTP Code: 400 Message: Client Error
HTTP Code: 500 Message: Server Error

Change Log

    June - 2021
    March - 2021 First updated
Last modified 3mo ago
Copy link
Contents
Change Log