XM

Retrieve a Single Promotion

Path:

GET /api-price/promo/{promoID}

This API retrieves details of a specific promotion based on the specified promotion ID.

Headers

Content-Type : application/json

x-site-context : {"stage":"dev02","account":"5f328bf0b7c15700071233b9","date":"","channel":12}

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: path

Name: promo ID

Required: true

Response

HTTP Code: 200 Message: OK

Sample:

{
"_id": "5ff58d31358319306ac05349",
"promoCodes": [
"updatePromoCoad"
],
"state": "ACTIVE",
"isImplicit": false,
"isExclusive": false,
"title": "bogo update promo",
"startDate": "2021-01-06T18:30:00.000Z",
"endDate": "2021-01-08T18:30:00.000Z",
"type": "PRODUCT",
"promo": [
{
"condition": [
{
"_id": "5ff58d30358319306ac05348",
"operator": "AND",
"conditions": [
{
"value": "*",
"operator": "IN",
"key": "SKU",
"id": null
},
{
"key": "PRICE_KIND",
"value": "BASE",
"operator": "EQUAL",
"id": null
},
{
"key": "QUANTITY",
"value": "3",
"operator": "GREATER_THAN_OR_EQUAL_TO",
"id": null
},
{
"key": "USER_KIND",
"value": "ALL",
"operator": "EQUAL",
"id": null
}
],
"createdAt": "2021-01-06T10:13:04.426Z",
"updatedAt": "2021-01-06T10:36:40.787Z",
"__v": 0
}
],
"discount": [
{
"_id": "5ff592b9358319306ac0534c",
"unit": "%OFF",
"value": 7,
"ON": {
"kind": "SKU",
"quantity": 5,
"value": null
},
"id": "5ff592b9358319306ac0534c"
}
],
"targetProducts": [
{
"kind": "SKU",
"value": "*",
"operator": "IN",
"id": null
}
],
"id": null
}
],
"extra": {
"promoTiers": [
{
"id": 0,
"buyValue": "",
"typeWithValues": {
"selectedPromotionType": "Percentage off",
"promotionTypeValue": "7",
"shippingPromotionTypeValue": "",
"selectedShippingType": "Ground",
"selectedShippingPromotionType": "Percentage off"
}
}
],
"categoriesPath": {},
"selectedPriceRadio": "Base price",
"selectedPromoTypeRadio": "SKU(s)",
"getYSameSku": "5",
"buyXSameSku": "3",
"targetType": "targetX",
"selectedAdvancedOption": "SAME_SKUS",
"userKind": "All",
"target": {
"types": {
"targetX": {
"selectedSkus": {},
"selectedCategories": {},
"products": [],
"radioId": "ALL_PRODUCTS",
"skusCount": 0,
"selectedAttributesTree": {},
"selectedAttributes": [],
"totalProductsCount": 0,
"categoriesSkusCount": 0,
"attributesItemDetails": {}
}
}
},
"isAdvanceOptionsOpen": true,
"selectedExplicitOption": "isMultiple"
},
"limits": [],
"promoId": 1422,
"termsAndConditions": [],
"createdAt": "2021-01-06T10:13:05.169Z",
"updatedAt": "2021-01-06T10:36:41.038Z",
"__v": 0
}

HTTP Code: 400 Message: Client Error

HTTP Code: 500 Message: Server Error

Changelog

*Last updated - March 2021