Composite Promotion

Output representation of the composite promotion information.

JSON example

1{
2  "name": "Buy Tennis racquet, and tennis shoes get 20% off and buy minimum of 2 tennis balls get 10% off",
3  "description": "Buy Tennis racquet, and tennis shoes get 20% off and buy minimum of 2 tennis balls get 10% off",
4  "currencyIsoCode": "USD",
5  "areQualItemsExclFromDiscounts": true,
6  "discountOrder": "MostExpensive",
7  "discountRestriction": "None",
8  "active": false,
9  "MaximumUsageCount": 1,
10  "PriorityNumber": null,
11  "IsTiered": false,
12  "Objective": "Upsell tennis products",
13  "IsAutomatic": false,
14  "startDateTime": "2022-05-09T20:00:00.000+0000",
15  "endDateTime": "2022-05-17T19:00:00.000+0000",
16  "displayName": {
17    "default": "Buy Tennis racquet, and tennis shoes get 20% off and buy minimum of 2 tennis balls get 10% off",
18    "translations": [
19      {
20        "fr": "Achetez un p1, p2 ou p3, obtenez un 2e produit à 20 % de réduction"
21      },
22      {
23        "de": "Kaufen Sie ein p1, p2 oder p3 und erhalten Sie 20 % Rabatt auf ein zweites Produkt"
24      }
25    ]
26  },
27  "termsAndConditions": {
28    "default": "Buy Tennis racquet, and shoes get 20% off and buy tennis balls get 10% off",
29    "translations": [
30      {
31        "fr": "Achetez un p1, p2 ou p3, obtenez un 2e produit à 20 % de réduction, jusqu'à épuisement des stocks"
32      },
33      {
34        "de": "Kaufen Sie ein p1, p2 oder p3 und erhalten Sie 20% Rabatt auf ein zweites Produkt, solange der Vorrat reicht"
35      }
36    ]
37  },
38  "qualifiers": [
39    {
40      "qualifierType": "Quantity",
41      "qualifierValue": "3",
42      "currencyIsoCode": "USD",
43      "qualifierReference": [
44        {
45          "name": "Tennis racquet",
46          "id": "ODDD12323432423",
47          "itemReferenceType": "Product",
48          "operatorType": "EQUALS_TO"
49        },
50        {
51          "name": "Tennis shoes",
52          "id": "ODDD123234323422",
53          "itemReferenceType": "Product",
54          "operatorType": "EQUALS_TO"
55        }
56      ]
57    },
58    {
59      "qualifierType": "Amount",
60      "qualifierValue": "100",
61      "currencyIsoCode": "USD",
62      "qualifierReference": [
63        {
64          "name": "Tennis Balls",
65          "id": "ODDD12323432423",
66          "itemReferenceType": "Product",
67          "operatorType": "EQUALS_TO"
68        }
69      ]
70    }
71  ],
72  "targets": [
73    {
74      "adjustmentType": "PercentageDiscount",
75      "adjustmentValue": "20",
76      "currencyIsoCode": "USD",
77      "isMinItemCountRequired": false,
78      "restrictionQuantity": null,
79      "ruleCriteriaType": "ANY_REQUIRED",
80      "targetReferences": [
81        {
82          "id": "ODDD12323432423",
83          "itemReferenceType": "Product",
84          "name": "Tennis racquet",
85          "operatorType": "EQUAL_TO"
86        }
87      ]
88    },
89    {
90      "adjustmentType": "PercentageDiscount",
91      "adjustmentValue": "10",
92      "currencyIsoCode": "USD",
93      "isMinItemCountRequired": false,
94      "restrictionQuantity": null,
95      "ruleCriteriaType": "ANY_REQUIRED",
96      "targetReferences": [
97        {
98          "id": "ODDD12323432423",
99          "itemReferenceType": "Product",
100          "name": "Tennis Balls",
101          "operatorType": "EQUAL_TO"
102        }
103      ]
104    }
105  ],
106  "segments": [
107    {
108      "webstoreId": "0ZExx0000000085GAA",
109      "webstoreName": "ABC Store"
110    }
111  ]
112}

Property Name	Type	Description	Filter Group and Version	Available Version
`active`	Boolean	Indicates whether the promotion is active (`true`) or not (`false`).	Small, 62.0	62.0
`areQualItemsExclFromDiscounts`	Boolean	Indicates whether qualifying items are excluded from discounts for the promotion (`true`) or not (`false`).	Small, 62.0	62.0
`coupons`	Composite Promotion Coupon[]	List of coupons associated with the promotion.	Small, 63.0	63.0
`currencyIsoCode`	String	Three-letter ISO 4217 currency code associated with the promotion.	Small, 62.0	62.0
`description`	String	Description of the promotion.	Small, 62.0	62.0
`discountOrder`	String	Discount order for the promotion. Possible values are: `LeastExpensive` `MostExpensive`	Small, 62.0	62.0
`discountRestriction`	String	Discount restriction for the promotion. Possible values are: `LeastExpensive` `None`	Small, 62.0	62.0
`displayName`	Promotion Translation	Promotion display name and translated values.	Small, 62.0	62.0
`endDateTime`	String	The date time the promotion ends.	Small, 62.0	62.0
`exclusivityType`	String	Type of exclusivity to be considered when applying the promotion. Possible values are: `Class`—Class exclusion. `Global`—Global exclusion. `No`—No exclusion.	Small, 62.0	62.0
`generationId`	String	ID of the generated promotion. This field is used to display the feedback component and collect promotion feedback when Smart Promotion is enabled.	Small, 62.0	62.0
`isApproachingDiscountApplicable`	Boolean	Indicates whether the promotion is an approaching discount (`true`) or not (`false`). If true, the promotion shows an approaching discount alert.	Small, 64.0	64.0
`maximumUsageCount`	Integer	Number of times the promotion can apply to a cart.	Small, 62.0	62.0
`name`	String	Name of the promotion.	Small, 62.0	62.0
`objective`	String	Objective of the promotion.	Small, 62.0	62.0
`priorityNumber`	Integer	Priority number for the promotion.	Small, 62.0	62.0
`qualifierCriteria`	String	Qualifier criteria for the promotion. Possible values are: `All`—All the criteria are met. `Any`—Any of the criteria can be met.	Small, 62.0	62.0
`qualifiers`	Promotion Qualifier[]	List of promotion qualifiers.	Small, 62.0	62.0
`segments`	Promotion Segment[]	List of promotion segments associated with the web store or buyer group.	Small, 62.0	62.0
`startDateTime`	String	The date time the promotion starts.	Small, 62.0	62.0
`targetCriteria`	String	Promotion criteria type. Possible values are: `All`—All the criteria are met. `Any`—Any of the criteria can be met.	Small, 62.0	62.0
`targets`	Promotion Target[]	List of promotion targets.	Small, 62.0	62.0
`termsAndCondition`	Promotion Translation	Promotion terms and conditions and translated values.	Small, 62.0	62.0
`tiered`	Boolean	Indicates whether promotion is tiered (`true`) or not (`false`).	Small, 62.0	62.0

Connect REST API Developer Guide

Composite Promotion

See Also