Sitecore OrderCloud Documentation

docs

Portal Login

Get a single promotion.

GET

/me/promotions/{promotionID}

200

Description

Only available to Buyer Users.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessShopper

Parameters

NameTypeDescriptionPossible Values
promotionIDRequiredstringID of the promotion.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
LineItemLevelboolean---------

Codestring---100 characters---

Namestring---100 characters---
RedemptionLimitintegerint32------

RedemptionLimitPerUserintegerint32------

RedemptionCountRead Onlyintegerint32------

Descriptionstring---2000 characters---
FinePrintstring---2000 characters---

StartDatestringdate-time------
ExpirationDatestringdate-time------
EligibleExpressionstring---400 characters---

ValueExpressionstring---400 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

AutoApplyboolean---------
Activeboolean---------
Priorityintegerint32------

xpobject---------

Get a single promotion.

GET

/me/promotions/{promotionID}

200

Description

Only available to Buyer Users.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessShopper

Parameters

NameTypeDescriptionPossible Values
promotionIDRequiredstringID of the promotion.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
LineItemLevelboolean---------

Codestring---100 characters---

Namestring---100 characters---
RedemptionLimitintegerint32------

RedemptionLimitPerUserintegerint32------

RedemptionCountRead Onlyintegerint32------

Descriptionstring---2000 characters---
FinePrintstring---2000 characters---

StartDatestringdate-time------
ExpirationDatestringdate-time------
EligibleExpressionstring---400 characters---

ValueExpressionstring---400 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

AutoApplyboolean---------
Activeboolean---------
Priorityintegerint32------

xpobject---------
Sitecore Logo

© Copyright 2023, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore