1. Output

RESPONSE PROPERTIES

Property REQUIRED Comments Example
BEES Customer BEES Force
output object true false Type of benefit that will be applied if conditions are satisfied.
output.orderTotalDiscount object false false Amount or percent given as benefit in the order level.
output.orderTotalDiscount.type string true false The discount type represents the way it's going to be calculated.
$ | AMOUNT_OFF | % | PERCENT_OFF
output.orderTotalDiscount.discount number false false The discount amount for this deal. Its application depends on the type and it is a financial value with the max number of decimal places as 15.
> 0
output.orderTotalDiscount.proportion integer false false Defines the total discount based on the quantity of items purchased.
>=1
output.lineItemDiscount object false false Amount or percent given as benefit in the line item level vendorItemId.
output.lineItemDiscount.vendorItemIds array[string] true false The list of vendorItemIds in lineItemDiscountOutput.
output.lineItemDiscount.type string false false The discount type represents the way it's going to be calculated. It can be percent, cash or promotional price.
Allowed values:
% | $| @ | PERCENT_OFF | AMOUNT_OFF | PROMOTIONAL_PRICE
output.lineItemDiscount.value number false false The discount value for this deal. Its application depends on the type and it is a financial value with the max number of decimal places as 15.
>= 0
output.lineItemDiscount.maxQuantity integer false false The maximum amount of items that can receive discounts.
>= 1
output.lineItemDiscount.proportion integer false false Defines the total discount based on the quantity of items purchased.
>= 1
output.palletDiscount object false false Discount given to POCs that are responsible to unload the truck during delivery.
output.palletDiscount.discount number false false The discount amount for this deal. It is a financial value with the max number of decimal places as 15.
>= 0
output.palletDiscount.proportion integer false false Defines the total discount based on the quantity of items purchased.
>= 1
output.palletDiscount.measureUnit string false false The measure unit valid for the current deal.
output.lineItemScaledDiscount object false false Scaled amount or percent given as benefit in the line item level vendorItemIds.
output.lineItemScaledDiscount.vendorItemIds array[string] true false The list of alphanumeric identifiers vendorItemIds in scaledLineItemDiscountOutput.
output.lineItemScaledDiscount.ranges array[string] true false
output.lineItemScaledDiscount.ranges.from integer true false The minimum amount of purchase for this range.
output.lineItemScaledDiscount.ranges.to integer true false The maximum amount of purchase for this range.
output.lineItemScaledDiscount.ranges.type string true false The discount type represents the way it's going to be calculated. It can be percent, cash or promotional price.
Allowed values:
PERCENT_OFF| % | PROMOTIONAL_PRICE | @| AMOUNT_OFF| $ 		%
output.lineItemScaledDiscount.ranges.value number false false The discount value for this deal. Its application depends on the type and it is a financial value with the max number of decimal places as 15.
>= 0
output.lineItemScaledDiscount.ranges.maxQuantity integer false false The maximum amount of items that can receive discounts.
>= 1
output.lineItemScaledDiscount.ranges.proportion integer false false Defines the total discount based on the quantity of items purchased.
>= 1
output.freeGoods object false false For this type of deal, the customer earns an item of the specific list if they achieve the minimum quantity of the combination.
output.freeGoods.proportion integer false false Defines the total of Free Goods based on the quantity of items purchased.
>= 1
output.freeGoods.partial boolean false false Indicates that the Free Good benefit is partially redeemable.
Default: false
output.freeGoods.items array[object] true false The Free Goods available items to be picked for free.
output.freeGoods.items.vendorItems array[object] true false The list of vendorItems available to be picked for free.
output.freeGoods.items.vendorItems.vendorItemId string true false The alphanumeric identifier vendorItemId of Free Good item.
output.freeGoods.items.vendorItems.measureUnit string false false The measure unit for the current vendorItemId.
output.freeGoods.items.vendorItems.price number false false The price related to the free good.
output.freeGoods.items.quantity integer false false The quantity of Free Goods for the current deal.
>= 1
output.scaledFreeGoods object false false An explanation about the purpose of this instance.
output.scaledFreeGoods.partial boolean false false Indicates that the Free Good benefit is partially redeemable.
Default: false
output.scaledFreeGoods.ranges array[object] true false
output.scaledFreeGoods.from integer true false The minimum amount of purchase for this range.
output.scaledFreeGoods.to integer false false The maximum amount of purchase for this range.
output.scaledFreeGoods.ranges.proportion integer false false Defines the total discount based on the quantity of items purchased.
>= 1
output.scaledFreeGoods.ranges.items array[object] true false
output.scaledFreeGoods.ranges .items.vendorItems array[object] true false An explanation about the purpose of this instance.
output.scaledFreeGoods.ranges .items.vendorItems.vendorItemId string true false The alphanumeric identifier vendorItemId of Free Good item.
output.scaledFreeGoods.ranges .items.vendorItems.measureUnit string false false The measure unit for the current vendorItemId.
output.scaledFreeGoods.ranges .items.vendorItems.price number false false The price related to the free good.
output.scaledFreeGoods.ranges .items.quantity integer false false The quantity of Free Goods for the current deal.
>= 1
output.multipleLineItemDiscount object false false
output.multipleLineItemDiscount.type string true false The item discount type.
Allowed values:
% | $ | @ | PERCENT_OFF | AMOUNT_OFF | PROMOTIONAL_PRICE
output.multipleLineItemDiscount.items array[object] true false
output.multipleLineItemDiscount.items.vendorItemId string true false The alphanumeric identifier vendorItemId
output.multipleLineItemDiscount.items.value number true false Individual vendorItemId discount as amount. It is a financial value with the max number of decimal places as 15.
> 0
output.multipleLineItemDiscount.items.maxQuantity integer false false The maximum quantity allowed for each vendorItemId.
>= 1