| Name | Description | Type | Additional information |
|---|---|---|---|
| PromotionId |
The unique Id for this promotion |
globally unique identifier |
None. |
| CompanyId |
The company Id this promotion belongs to |
integer |
None. |
| Name |
The name of the promotion |
string |
None. |
| Status |
The status of the Promotion. 'Active' or 'Deleted'. Results from this endpoint will always be 'Active' |
string |
None. |
| HumanReadablePromotionType |
A human readable string representing the type of promotion. Can be 'BOGO', 'Buy X Get Y', 'Bundle', 'Dollar Off', or 'Percent Off' Based on PromotionType. CheapestMatchedFor_ maps to 'BOGO'. MatchThenCheapestOtherFor_ maps to 'Buy X Get Y'. BundleFor_ maps to 'Bundle'. EachMatchedDollarOff maps to 'Dollar Off'. 'EachMatchedPercentOff' maps to 'Percent Off'. |
string |
None. |
| EnabledAtLocationIds |
A list of the Location identifiers where this promotion is applicable |
Collection of integer |
None. |
| ICalVEventSchedule |
An iCal formatted VEVENT string representing the period of time the promotion is active. See [iCal documentation](https://icalendar.org/) for more information. The PromotionId will always be included as the SUMMARY. |
string |
None. |
| CreatedByUserId |
The userId that created this promotion. |
integer |
None. |
| CreatedDateTimeUtc |
The DateTime this promotion was created. |
date |
None. |
| Version |
The current version of this promotion. Increments by 1 for each change made to this promotion. |
integer |
None. |
| CatalogIds |
A list of catalogIds that this promotion can apply to |
Collection of globally unique identifier |
None. |