| Property |
REQUIRED |
Comments |
Example |
| BEES Customer |
BEES Force |
| conditions array[object] |
false |
false |
Set of rules combined that decides if deal is going to be applied or not. |
|
| conditions.paymentMethod string |
false |
false |
The payment method condition for the current deal. |
|
| conditions.simulationDateTime object |
false |
false |
The payment method the customer needs to choose to satisfy the condition. |
|
| conditions.simulationDateTime.startDateTime string |
true |
false |
The start date time for this condition. |
2020-01-01T14:48:05Z |
| conditions.simulationDateTime.endDateTime string |
true |
false |
The end date time for this condition. |
2020-12-31T14:48:05Z |
| conditions.deliveryDate array[object] |
false |
false |
|
|
| conditions.deliveryDate.startDate string |
true |
false |
The validity start date for this deal |
|
| conditions.deliveryDate.endDate string |
true |
false |
The validity end date for this deal |
|
| conditions.firstOrder boolean |
false |
false |
This field identifies that the deal will only be applied during the user first purchase. |
false |
| conditions.couponCode string |
false |
false |
If the couponCode is sent in the simulation and the deal have this attribute, it will be used to apply the coupon discount. These deals are also returned or not in the catalog endpoints depending on hiddenOnBrowse. Notice that this is a deal condition, and not a deal type. |
|
| conditions.lineItem object |
false |
false |
|
|
| conditions.lineItem.vendorItemIds array[string] |
true |
false |
The list of alphanumeric identifiers vendorItemIds that allow this discount. |
|
| conditions.lineItem.minimumQuantity integer |
false |
false |
The minimum quantity in the cart of these products to be eligible to for this deal. |
|
| conditions.lineItem.sharedMinimumQuantity boolean |
false |
false |
Indicates if this deal considers all items to reach minimum quantity. |
|
| conditions.lineItem.crossDiscount boolean |
false |
false |
A flag that indicates if the discount can be applied to a different vendorItemId from the condition in the Output. |
|
| conditions.multipleLineItem object |
false |
false |
|
|
| conditions.multipleLineItem.items array[object] |
true |
false |
Defines the minimum quantity of multiple products that should be purchased together as group or combo. |
|
| conditions.multipleLineItem.items.vendorItemIds array[string] |
true |
false |
The list of alphanumeric identifiers vendorItemIds that allow this discount. |
|
| conditions.multipleLineItem.items.minimumQuantity integer |
false |
false |
The minimum valid quantity for among the items for this deal.
>= 1
|
20 |