3. Enforcement

Enforcement management documentation

Payload Breakdown

Enforcement is a very useful and complete entity, among the most important functionalities is the capability of segmenting the amount of product that will be available at POC level, as well as defining when this amount configured can be renewed, daily, weekly or monthly basis, and also being able to set a date until the limit will become inactive.

The Enforcement is also able to configure limits to manage products that are being offered for free, which is normally called freegoods. Enforcement is capable of managing the amount of freegoods that a specific POC would be able to redeem for a given period.

  • Seasonal Products:
    • Let's assume there is a new seasonal product, however, the commercial team wants to allow POC's to purchase this product. Instead of setting only the inventory at DDC level, enforcement is able to set an amount such as 10, for all POC's. Therefore, given an opportunity to all POC's to purchase the seasonal products and avoiding that only a couple POC purchase all the inventory.
  • Freegoods Limits:
    • As mentioned above, enforcement is able to designated an amount of freegoods products to be redeem by POCs in order to avoid that a POC purchases and redeem a lot of freegoods products.
  • Combined Inventory [Enforcement + Adjusting]:
    • Enforcement can also be used together with the Inventory Adjusting type. Therefore, it would be configure a inventory quantity for the entire DDC and on top of that also setting a limit for a given POC.

Property

Description

Required

Example

enforcements

List of enforcements to configure.

false

enforcements.[].entity

The enforce entity.

true

"VENDOR_ITEM"

enforcements.[].entityId

The entity key. This field refers to the id of the entity.

true

"DEMO001"

enforcements.[].limits.renew

The cadence of renewal limits.

false

"WEEKLY"

enforcements.[].limits.value

Available amount.

true

100

enforcements.[].startDate

Date when the limit will become active.

false

"2023-12-08T00:00:00.000Z"

enforcements.[].endDate

Date until limit is active, after this date the limit configured will be disabled.

false

"2023-12-31T00:00:00.000Z"

enforcements.[].type

The limit type Allowed values: AVAILABILITY, BUDGET, QUANTITY or SHARED_AVAILABILITY

true

"QUANTITY"

vendorAccountIds

List of vendorAccountIds to configure the list of enforcements.

false

["62691196000165"]

vendorDeliveryCenterIds

List of DDCs to configure the list of enforcements.

false

["DDC001"]