Campaign document (Data API 23.2)
(supports custom properties)
Document representing a campaign.
| Property | Type | Constraints | Description |
|---|---|---|---|
campaign_id |
String | maxLength=256, minLength=1 | The ID of the campaign. |
coupons |
[String] | The array of assigned coupon IDs, not sorted | |
creation_date |
Date | Returns the value of attribute 'creationDate'. | |
customer_groups |
[String] | The array of assigned customer groups, not sorted | |
description |
String | maxLength=4000, minLength=0 | The description of the campaign. |
enabled |
boolean | The enabled flag for campaign. | |
end_date |
DateTime | The date that the Scenario ends | |
last_modified |
Date | Returns the value of attribute 'lastModified'. | |
link |
String | link for convenience | |
source_code_groups |
[String] | The array of assigned source code groups, not sorted | |
start_date |
DateTime | The date that the Scenario begins |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
