4. Product Assortment

Assortment management documentation

Payload Breakdown

The Product Assortment entity is responsible to establish the relationship between a product and the delivery center. It is a fundamental step because without this relationship the product wont appear in the BEES Application.

In simple terms, the Product Assortment will look at a POC and will identify what delivery center they have relationship with. Then, it will return all products that are assorted in that relationship with the goal of showing only the products that are within the Delivery Center for that POC.

The Product Assortment is very simple and straightforward entity, it contains only three fields, being two of them mandatory. The fields are described below in more details:

  • Delivery Center Ids:

    This is the unique identifier of the deliver center that will contain the products assorted;

  • Assorments - VendorItemId: The unique identifier of the sku/vendorItemId that will be assorted for a specific delivery center id;

  • Assorments - DeliveryMethod: This property is not mandatory, however, it is important to emphasize the flexibility that it gives. There are a couple of types that this property expects and based on a specific type the product can be delivered in different ways or even picked up by the customer. The methods [EXPRESS] and [SPONSORED] defines that a product can be delivered earlier than the common delivery and for some cases it can also incur an extra charge. The [PICKUP] method is self explanatory and refers to products that can picked up by the POC in that specific delivery center. The [STANDARD] is the default option and states the regular relationship with delivery center and product without any considerations.

Property

Description

Required

Example

deliveryCenterIds

List of delivery centers to include the SKUs to.

true

["DDC001"]

assortments

List of assortments.

true

 

assortments.[].vendorItemId

The vendor item id that is allowed to be offered by the DDC.

true

"1234567890"

assortments.[].deliveryMethods

The delivery methods allowed for all the vendorItemIds informed in the payload.

Allowed values:

PICKUP, EXPRESS, SPONSORED, STANDARD

false

"STANDARD"