curl --request GET \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-price/promo/{promoId} \
--header 'x-site-context: <x-site-context>'
{
"_id": "5ff58d31358319306ac05349",
"promoCodes": [
"updatePromoCode"
],
"state": "ACTIVE",
"isImplicit": false,
"isExclusive": false,
"title": "HURRY",
"startDate": "2020-12-03T09:30:00.965Z",
"endDate": "2020-12-03T18:30:00.000Z",
"type": "PRODUCT",
"promo": [
{
"condition": [
"5fc8aedcdf91700008c62917"
],
"discount": [
{
"_id": "5f9be340dde1cd0008f96035",
"unit": "AMOUNT_OFF",
"value": 300,
"ON": {
"kind": "SKU",
"value": null
},
"id": "5f9be340dde1cd0008f96035",
"promoId": "5f9be340dde1cd0008f96034",
"promoCode": "300DOFF",
"promoTitle": "SKU 300 D off all skus",
"type": "COUPON"
}
],
"targetProducts": [
{
"kind": "SKU",
"value": "*",
"operator": "IN"
}
]
}
],
"extra": {},
"limits": {
"_id": "603eae614b40770007494683",
"kind": "PER_USER",
"value": 4,
"id": "603eae614b40770007494683"
},
"promoId": 1422,
"termsAndConditions": {
"_id": "5fc8ad76969f071ff85221e4",
"title": "Entering a Coupon",
"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."
},
"createdAt": "2021-01-06T10:13:05.169Z",
"updatedAt": "2021-01-06T10:36:41.038Z",
"__v": 0
}
Retrieves details of a specific promotion based on the specified promotion ID.
curl --request GET \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-price/promo/{promoId} \
--header 'x-site-context: <x-site-context>'
{
"_id": "5ff58d31358319306ac05349",
"promoCodes": [
"updatePromoCode"
],
"state": "ACTIVE",
"isImplicit": false,
"isExclusive": false,
"title": "HURRY",
"startDate": "2020-12-03T09:30:00.965Z",
"endDate": "2020-12-03T18:30:00.000Z",
"type": "PRODUCT",
"promo": [
{
"condition": [
"5fc8aedcdf91700008c62917"
],
"discount": [
{
"_id": "5f9be340dde1cd0008f96035",
"unit": "AMOUNT_OFF",
"value": 300,
"ON": {
"kind": "SKU",
"value": null
},
"id": "5f9be340dde1cd0008f96035",
"promoId": "5f9be340dde1cd0008f96034",
"promoCode": "300DOFF",
"promoTitle": "SKU 300 D off all skus",
"type": "COUPON"
}
],
"targetProducts": [
{
"kind": "SKU",
"value": "*",
"operator": "IN"
}
]
}
],
"extra": {},
"limits": {
"_id": "603eae614b40770007494683",
"kind": "PER_USER",
"value": 4,
"id": "603eae614b40770007494683"
},
"promoId": 1422,
"termsAndConditions": {
"_id": "5fc8ad76969f071ff85221e4",
"title": "Entering a Coupon",
"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."
},
"createdAt": "2021-01-06T10:13:05.169Z",
"updatedAt": "2021-01-06T10:36:41.038Z",
"__v": 0
}
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Get promotions based on promotion ID
Successfull
The response is of type object
.
Was this page helpful?