Add a promotion to an order.
POST
/orders/{direction}/{orderID}/promotions/{promoCode}
201Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdminShopper
Parameters
Name | Type | Description | Possible Values | |
---|---|---|---|---|
direction | Required | string | Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
orderID | Required | string | ID of the order. | --- |
promoCode | Required | string | Promo code of the order promotion. | --- |
Response Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
Amount | Read Only | number | float | --- | --- | |
LineItemID | Read Only | string | --- | --- | --- | |
AmountOverridden | Read Only | boolean | --- | --- | --- | |
DateApplied | Read Only | string | date-time | --- | --- | |
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 | --- | --- | |
QuantityLimitPerOrder | integer | int32 | --- | --- | ||
ItemLimitPerOrder | integer | int32 | --- | --- | ||
ItemSortBy | string | --- | 200 characters | --- | ||
Description | string | --- | 2000 characters | --- | ||
FinePrint | string | --- | 2000 characters | --- | ||
StartDate | string | date-time | --- | --- | ||
ExpirationDate | string | date-time | --- | --- | ||
EligibleExpression | string | --- | 400 characters | --- | ||
ValueExpression | string | --- | 1000 characters | --- | ||
CanCombine | boolean | --- | --- | --- | ||
AllowAllBuyers | boolean | --- | --- | --- | ||
OwnerID | string | --- | --- | --- | ||
AutoApply | boolean | --- | --- | --- | ||
Active | boolean | --- | --- | --- | ||
Priority | integer | int32 | --- | --- | ||
xp | object | --- | --- | --- |