Sitecore OrderCloud Documentation

docs

Portal Login

Create or update a promotion.

PUT

/promotions/{promotionID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

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

FullAccessPromotionAdmin

Parameters

NameTypeDescriptionPossible Values
promotionIDRequiredstringID of the promotion.---

Request Body

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

CodeRequiredstring---100 characters---

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

RedemptionLimitPerUserintegerint32------

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

StartDatestringdate-time------
ExpirationDatestringdate-time------
EligibleExpressionRequiredstring---400 characters---

ValueExpressionRequiredstring---400 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

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

xpobject---------

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---------

Create or update a promotion.

PUT

/promotions/{promotionID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

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

FullAccessPromotionAdmin

Parameters

NameTypeDescriptionPossible Values
promotionIDRequiredstringID of the promotion.---

Request Body

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

CodeRequiredstring---100 characters---

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

RedemptionLimitPerUserintegerint32------

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

StartDatestringdate-time------
ExpirationDatestringdate-time------
EligibleExpressionRequiredstring---400 characters---

ValueExpressionRequiredstring---400 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

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

xpobject---------

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 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore