Product Assortment Management

General Summary

Product Assortment MS is responsible for managing which SKU is available for each account in a given country.

There are two possible actions: include one sku for some Delivery Center or exclude the sku for some Account, and it can be done in any order, there is no need to do the inclusion first.

These can be done by sending requests to the Relay of Product Assortment. Depending on this, and other rules, the product will appear or not in the application for the user.

Architecture

Product Assortment depends on Items Service, where the SKU must be enabled to work with the Inclusion and Exclusion and finally appear or not to the user. The configuration of the item service feature, though, is not mandatory for the product assortment relay to work. On the other hand, Catalog service depends on Product Assortment and the Product Assortment configuration is mandatory for Catalog service work properly.

For more information about the microservices architecture see documentation of BEES micro-services.

Create an Inclusion

To manage an inclusion in product assortment service, there is a relay endpoint which can be used with two HTTP methods, POST and DELETE. This section will present the POST method, used to create an inclusion.

Highlight fields

Name

Description

Example

deliveryCenters

A list of delivery centers to which the item will be available.

"deliveryCenters":[ "DLC001", "DLC002" ]

Limits

Entity

Endpoint

Route

Compressed

Limit of Entities

deliveryCenters

/inclusion

POST

no

50000 DC per request

Delete an Inclusion

This section presents how to remove an inclusion of product assortment service using the DELETE HTTP method, and the same endpoint used for inclusion creation.

Limits

Endpoint

Route

Compressed

Limit of Entities

/inclusion

DELETE

no

1 sku

Create an Exclusion

To manage an exclusion in product assortment service, there is a relay endpoint which can be used with two HTTP methods, POST and DELETE. This section will present the POST method, used to create an exclusion.

Highlight fields

Name

Description

Example

accounts

A list of accounts to which the item will be excluded.

"accounts":["ACC001", "ACC002"]

Limits

Entity

Endpoint

Route

Compressed

Limit of Entities

accounts

/exclusion

POST

no

50000 accounts per request

Delete an Exclusion

This section presents how to remove an exclusion of product assortment service using the DELETE HTTP method, and the same endpoint used for exclusion creation.

Highlight fields

Name

Description

Example

sku

The unique identifier (ID) field for the item (product)

"SKU001"

accounts

A list of accounts to which the item will be excluded.

"accounts":["ACC001", "ACC002"]

OBS: Unlike the other product assortment methods, to delete an exclusion the request payload must include the sku parameter.

Limits

Entity

Endpoint

Route

Compressed

Limit of Entities

ExclusionDeleteRequest

/exclusion

DELETE

no

50000 accounts per request