Sitecore Ordercloud

Get a list of order promotions

GET
/orders/{direction}/{orderID}/promotions

Roles

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

FullAccess
OrderAdmin
Shopper
OrderReader

Parameters

NameTypeDescriptionPossible Values
directionstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDstringID of the order.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Code, Description, FinePrint, EligibleExpression, ValueExpression
sortByarrayComma-delimited list of fields to sort by.Name, ID, Code, StartDate, ExpirationDate, EligibleExpression, ValueExpression, CanCombine, AutoApply, Active, Priority, !Name, !ID, !Code, !StartDate, !ExpirationDate, !EligibleExpression, !ValueExpression, !CanCombine, !AutoApply, !Active, !Priority
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
PropertyTypeFormatMax LengthPossible Values
Amount
Read Only
numberfloat------
LineItemID
Read Only
string---------
IDstring---100 characters---
LineItemLevelboolean---------

Codestring---100 characters---

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

RedemptionLimitPerUserintegerint32------

RedemptionCount
Read Only
integerint32------

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

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

ValueExpressionstring---400 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

AutoApplyboolean---------
Activeboolean---------
Priorityintegerint32------
xpobject---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------
NextPageKeystring---------