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

Name	Type	Description	Possible Values
direction	`string`	Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.	Incoming, Outgoing, All
orderID	`string`	ID of the order.	---
search	`string`	Word or phrase to search for.	---
searchOn	`array`	Comma-delimited list of fields to search on.	ID, Name, Code, Description, FinePrint, EligibleExpression, ValueExpression
sortBy	`array`	Comma-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
page	`integer`	Page 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.	---
pageSize	`integer`	Number of results to return per page. Default: 20, max: 100.	---
filters	`object`	An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'	---

Property Type Format Max Length Possible Values

Items array --- --- ---

Property		Type	Format	Max Length	Possible Values
Amount	Read Only	`number`	float	---	---
LineItemID	Read Only	`string`	---	---	---
ID		`string`	---	100 characters	---
LineItemLevel		`boolean`	---	---	---
Code		`string`	---	100 characters	---
Name		`string`	---	100 characters	---
RedemptionLimit		`integer`	int32	---	---
RedemptionLimitPerUser		`integer`	int32	---	---
RedemptionCount	Read Only	`integer`	int32	---	---
Description		`string`	---	2000 characters	---
FinePrint		`string`	---	2000 characters	---
StartDate		`string`	date-time	---	---
ExpirationDate		`string`	date-time	---	---
EligibleExpression		`string`	---	400 characters	---
ValueExpression		`string`	---	400 characters	---
CanCombine		`boolean`	---	---	---
AllowAllBuyers		`boolean`	---	---	---
OwnerID		`string`	---	---	---
AutoApply		`boolean`	---	---	---
Active		`boolean`	---	---	---
Priority		`integer`	int32	---	---
xp		`object`	---	---	---

Meta object --- --- ---

Property	Type	Format	Max Length	Possible Values
Page	`integer`	int32	---	---
PageSize	`integer`	int32	---	---
TotalCount	`integer`	int32	---	---
TotalPages	`integer`	int32	---	---
ItemRange	`array`	---	---	---
NextPageKey	`string`	---	---	---