GET
/
api-price
/
promo
/
{promoId}
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
}

Headers

​
x-site-context
string
required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
promoId
string
required

Get promotions based on promotion ID

Response

200
application/json
Successfull
​
_id
string

The 24 character system-generated ID (for internal use only).

Example:

"5ff58d31358319306ac05349"

​
promoCodes
string[]

The promotional codes.

Example:
["updatePromoCode"]
​
state
enum<string>

The state of the promotion.

Available options:
SCHEDULED,
ACTIVE,
DISABLED,
EXPIRED
Example:

"ACTIVE"

​
isImplicit
boolean

True indicates that the promo is a coupon and False indicates promotion.

Example:

false

​
isExclusive
boolean

True indicates that coupon is non-stackable and False indicates stackable.

Example:

false

​
title
string

The title of the promotion.

Example:

"HURRY"

​
startDate
string

The promotion start date and time, in ISO format.

Example:

"2020-12-03T09:30:00.965Z"

​
endDate
string

The promotion end date and time, in ISO format.

Example:

"2020-12-03T18:30:00.000Z"

​
type
string

The type or kind to which the promotion is applied.

Example:

"PRODUCT"

​
promo
object[]

The details of the promotions.

​
extra
object

For internal use only.

Example:
{}
​
limits
object

The coupon or promo limitations. For example, limit can be set for the coupon to be used only 4 times per user and 10 times in total across all customer.

​
promoId
number

The human-readable ID for a set of promotion codes, for external use.

Example:

1422

​
termsAndConditions
object

The terms and conditions of the promotion.

​
createdAt
string

The time stamp of promo creation, in ISO format.

Example:

"2021-01-06T10:13:05.169Z"

​
updatedAt
string

The time stamp of promo update, in ISO format.

Example:

"2021-01-06T10:36:41.038Z"

​
__v
number

The internal version of the record.

Example:

0

Was this page helpful?

Validate PromotionsOverview