Get Promotions by promotion ID

Retrieves details of a specific promotion based on the specified promotion ID.

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.

Path Parameters

promoId

string

required

Get promotions based on promotion ID

Response

200 - application/json

__v

number

The internal version of the record.

_id

string

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

createdAt

string

The time stamp of promo creation, in ISO format.

endDate

string

The promotion end date and time, in ISO format.

extra

object

For internal use only.

isExclusive

boolean

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

isImplicit

boolean

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

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.

Show child attributes

limits._id

string

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

limits.id

string

The reference ID of the limit (for internal use only).

limits.kind

string

Represents coupon or promo limitation per customer and/or across the site (for all customers).

limits.value

number

The value set for the limit.

promo

object[]

The details of the promotions.

Show child attributes

promo.condition

string[]

The condition ID (for internal use only).

promo.discount

object[]

The details of the applicable discount.

Show child attributes

promo.discount._id

string

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

promo.discount.id

string

The ID of the discount.

promo.discount.ON

object

For internal use only. Represents the promotion type (SKU, CART, or QUANTITY) that was applied.

Show child attributes

promo.discount.ON.kind

enum<string>

The kind or type to which the promotion is applied.

Available options:

SKU,

CATEGORY,

ATTRIBUTE

promo.discount.ON.value

string

The value of promotion.

promo.discount.promoCode

string

The promo code (for customer use).

promo.discount.promoId

string

The 24 character system-generated ID for a set of promotion codes.

promo.discount.promoTitle

string

The title of the promotions.

promo.discount.type

enum<string>

The type of promotions.

Available options:

PROMOTION-SKU,

PROMOTION-SHIPPING,

PROMOTION-CART,

PROMOTION-QUANTITY,

COUPON

promo.discount.unit

enum<string>

The unit of discount. Represents whether the discount is in percentage or dollar value.

Available options:

%OFF,

AMOUNT_OFF

promo.discount.value

number

The discount value.

promo.targetProducts

object[]

Represents the type or kind of target products, to run the promotions.

Show child attributes

promo.targetProducts.kind

enum<string>

Represents the type or kind of target products.

Available options:

SKU,

CATEGORY,

ATTRIBUTE

promo.targetProducts.operator

enum<string>

Represents the supported operations on the targer product.

Available options:

NOT_IN,

IN,

EQUAL

promo.targetProducts.value

string

Represents the target product for which offer must be applied as per the selected operator and kind.

promoCodes

string[]

The promotional codes.

promoId

number

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

startDate

string

The promotion start date and time, in ISO format.

state

enum<string>

The state of the promotion.

Available options:

SCHEDULED,

ACTIVE,

DISABLED,

EXPIRED

termsAndConditions

object

The terms and conditions of the promotion.

Show child attributes

termsAndConditions._id

string

The system-generated ID for the terms and conditions (for internal use only).

termsAndConditions.description

string

The description of the terms and condition.

termsAndConditions.title

string

The title of the terms and condition.

title

string

The title of the promotion.

type

string

The type or kind to which the promotion is applied.

updatedAt

string

The time stamp of promo update, in ISO format.