Create a new promotion.
POST
/promotions
201Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Request Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
LineItemLevel | boolean | --- | --- | --- | ||
Code | Required | string | --- | 100 characters | --- | |
Name | string | --- | 100 characters | --- | ||
RedemptionLimit | integer | int32 | --- | --- | ||
RedemptionLimitPerUser | 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 | Required | string | --- | 400 characters | --- | |
ValueExpression | string | --- | 1000 characters | --- | ||
CanCombine | boolean | --- | --- | --- | ||
AllowAllBuyers | boolean | --- | --- | --- | ||
OwnerID | string | --- | --- | --- | ||
AutoApply | boolean | --- | --- | --- | ||
Active | boolean | --- | --- | --- | ||
Priority | integer | int32 | --- | --- | ||
xp | object | --- | --- | --- |
Response Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
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 | --- | --- | --- |