PromotionCampaignAssignment Document (Data API 17.6)
(supports custom properties)
Document representing a promotion campaign assignment.
| Property | Type | Constraints | Description |
|---|---|---|---|
campaign
|
Campaign | The campaign | |
campaign_id
|
String | maxLength=256, minLength=1 | The id of the campaign. |
coupons
|
[String] | The sorted array of assigned coupon ids. | |
customer_groups
|
[String] | The sorted array of assigned customer groups. | |
description
|
String | maxLength=4000, minLength=0 | The description of the promotion campaign assignment. |
enabled
|
Boolean | True if the assignment resource is enabled | |
link
|
String | link for convenience | |
promotion
|
Promotion | The promotion | |
promotion_id
|
String | maxLength=256, minLength=1 | The id of the Promotion. |
rank
|
Integer | The rank of promotion campaign assignment | |
schedule
|
Schedule | The schedule of the assignment resource | |
source_code_groups
|
[String] | The sorted array of assigned source code groups. |
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.
