Sitecore OrderCloud Documentation

docs

Portal Login

Add a promotion to an order.

POST

/orders/{direction}/{orderID}/promotions/{promoCode}

201

Roles

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

FullAccessOrderAdminShopper

Parameters

NameTypeDescriptionPossible Values
directionRequiredstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDRequiredstringID of the order.---
promoCodeRequiredstringPromo code of the order promotion.---

Response Body

PropertyTypeFormatMax LengthPossible Values
AmountRead Onlynumberfloat------
LineItemIDRead Onlystring---------
AmountOverriddenRead Onlyboolean---------

DateAppliedRead Onlystringdate-time------
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---------

Add a promotion to an order.

POST

/orders/{direction}/{orderID}/promotions/{promoCode}

201

Roles

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

FullAccessOrderAdminShopper

Parameters

NameTypeDescriptionPossible Values
directionRequiredstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDRequiredstringID of the order.---
promoCodeRequiredstringPromo code of the order promotion.---

Response Body

PropertyTypeFormatMax LengthPossible Values
AmountRead Onlynumberfloat------
LineItemIDRead Onlystring---------
AmountOverriddenRead Onlyboolean---------

DateAppliedRead Onlystringdate-time------
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