Sitecore OrderCloud Documentation

docs

Portal login

Create a new promotion.

POST

/promotions

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

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

FullAccessPromotionAdmin

Request Body

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

CodeRequiredstring---100 characters---

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

RedemptionLimitPerUserintegerint32------

QuantityLimitPerOrderintegerint32------

ItemLimitPerOrderintegerint32------

ItemSortBystring---200 characters---

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

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

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

QuantityLimitPerOrderintegerint32------

ItemLimitPerOrderintegerint32------

ItemSortBystring---200 characters---

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

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

ValueExpressionstring---1000 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

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

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

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

Contact Us
Privacy Policy
Sitecore