Deals

Deals Payload

  1. General Information

RESPONSE PROPERTIES

Property REQUIRED Comments Example
BEES Customer BEES Force
type string true false The type of the deal contract.
Allowed values:
ACCOUNT | VENDOR | DELIVERY_CENTER
ACCOUNT
ids array[string] true false The list of ids alphanumeric identifiers.
deals array[object] true false The list of deals to be processed.
deals.vendorDealId string true false The Vendor Deal alphanumeric identifier
deals.vendorPromotionId string true false The alphanumeric identifier vendorPromotionId for the current deal.
deals.accumulationType string false false The accumulation type for this deal.
Allowed values:
ADD | COMPOSE | UNIQUE | HIGH | LOW
ADD
deals.priority integer false false The priority for this deal to be applied.
deals.level integer false false The level to define conflicting deal types.
deals.enforced boolean false false The field to inform if this Deal is mandatory to have Enforcement created.
deals.hiddenOnBrowse boolean false false This configuration makes the deal not be returned by the catalog deals endpoints. It's useful when you want the deal to be applied in the simulation, but not to be shown in the catalog.