Sitecore OrderCloud Documentation

docs

Portal login

Add a promotion to an order

POST

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

201,4XX

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

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

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

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

Contact Us
Privacy Policy
Sitecore