| VendorAccountIds |
Used to relate the accounts with the other services |
| Deals - vendorDealId |
Deal identification |
| VendorPromotionId |
ID of the promotion related to the Deal |
| AccumulationType |
Type of accumulation (used by AR): ADD, COMPOSE, UNIQUE, HIGH, LOW - Optional |
| Priority |
Priority of the deal to be applied - Optional |
| Level |
Level of the deal to be applied - Optional |
| Budget |
The budget for the customer (The discount of the customer cannot pass the deal budget - It is not saved into the PE database, Enforcement team handles this info) - Optional |
| Availability |
Number of times a promotion can be applied - Optional |
| QuantityLimit |
The limit number of the freegoods the customer is allowed to receive from this deal |
| Conditions |
Set of rules combined that decides if deal is going to be applied or not.
PaymentMethod - The payment method the customer needs to choose to satisfy the condition.
SimulationDateTime - Date of the simulation to satisfy the condition.
DeliveryDate - Date of the delivery to satisfy the condition.
LineItem:
- VendorItemIds - Used to identify list of products that the user needs to buy to meet the condition.
- MinimumQuantity - The minimum quantity in the cart of these products to be eligible to receive the benefit.
- SharedMinimumQuantity – A flag that indicates if the minimum quantity can be shared between the list of the VendorItemIds.
- CrossDiscount – A flag that indicates if the discount can be applied to a different VendorItemId from the Condition in the Output.
MultipleLineItem:
Items
- VendorItemIds – Used to identify list of products that the user needs to buy to meet the condition.
- MinimumQuantity - The minimum quantity in the cart of these products to be eligible to receive the benefit. |
| Output |
Type of benefit that will be applied if conditions are satisfied.
OrderTotalDiscount - Amount or percent given as benefit in the order level. Being them:
- Type – Amount ($) or percent (%).
- Discount – Value of the discount to be given
- Proportion – Every X number (quantity) to acquire a discount. It doesn’t work if Fixed is set to true.
- Fixed – Flag that indicates if the proportion will be applied. In case it’s false, the proportion should be greater than zero.
LineItemDiscount – Amount or percent given as benefit in the line item level (product). Being them:
- VendorItemIds – List of products that gets the discount
- Type - Amount ($) or percent (%)
- Value - Value of the discount to be given.
- MaxQuantity - The maximum quantity of VendorItemId that the discount can be applied
- Proportion – Every X number (quantity) to acquire a discount. It doesn’t work if Fixed is set to true.
PalletDiscount - Discount given to POCs that are responsible to unload the truck during delivery. Being Them:
- Discount – Value of the benefit.
- Proportion - Every X number (quantity) to acquire a discount.
- MeasureUnit – Measure unit of the beverages that fits in a pallet.
LineItemScaledDiscount – Scaled amount or percent given as benefit in the line item level (product). Follow the description of the field:
- VendorItemIds – List of products that gets the discount.
- Ranges:
- From – The intial quantity that the deal might be applied.
- To – The end quantity that the deal might be applied.
- Type – Amount ($) or percent (%).
- Value – Vale of the discount to be given.
- MaxQuantity – The maximum quantity of VendorItemId that the discount can be applied. It's required on the latest range.
- Proportion – Every X number to acquire a discount. It doesn’t work if Fixed is set to true.
- Fixed – Flag that indicates if the proportion will be applied. In case it’s false, the proportion should be greater than zero.
FreeGoods - For this type of deal, the customer earns an item of the specific list if they achieve the minimum quantity of the combination.
- Fixed – Flag that indicates if the proportion will be applied. In case it’s false, the proportion should be greater than zero.
- Proportion - Every X number to acquire a discount. It doesn’t work if Fixed is set to true.
- Items
- VendorItemIds - List of selectable products that can be given as freegoods.
- VendorItemId – Product identifier.
- MeasureUnit - The measure of unit of the product for freegoods: Example: UNIT, 6PACK, 12PACK
- Price – Value of te product.
- Quantity – Quantity of the product in the freegoods.
- Partial – Flag that indicates if the freegood can be partial redeemed.
ScaledFreeGoods - Scaled
- Ranges
- Index - Index of the scaled free good to be applied as discount.
- Items
- VendorItemIds – List of products
- VendorItemId – Product identifier.
- MeasureUnit - The measure of unit of the product for freegoods: Example: UNIT, 6PACK, 12PACK
- Price – Value of te product.
- Quantity - Quantity of the product in the freegoods.
- Fixed - Flag that indicates if the proportion will be applied. In case it’s false, the proportion should be greater than zero.
- Proportion - Every X number (quantity) to acquire a discount. It doesn’t work if Fixed is set to true.
- Partial - Flag that indicates if the freegood can be partial redeemed.
- MultipleLineItemDiscount:
- Type – Type of the discount to be applied. Example: PROMOTIONAL_PRICE, PERCENT_OFF
- Items
- VendorItemId – Product identifier.
- Value – Price of the product in the discount.
- MaxQuantity – Maximum quantity of products that will be given the discount. |