Items Management
General Summary
The Items Service is responsible to handle the Item (aka. product, SKU or material) entity insertion, deletion, maintainability (updating). An Item entity represents an available product for a specific Zone. It is also the root entity that allows to build the Product Assortment, Inventory and Prices entities relation flow, as well the integration with the information provided by the Content Management System (CMS) tool.
Item Insertion and Update
Item insertion and update are done using the same relay endpoint and the HTTP method PUT.
Required Fields
A set of the required fields to have a valid single item are described below:
Name
Description
Example
sku
Unique identifier (ID) field for SKU
"000002", "000000000000085001"
name
Item’s (SKU) name
"Soda", "Soda Zero"
brandId
It is the item brand ID.When the brand is not available, each country has their specific rule to define this code.
322480
package
id
name
count
Array structure to describe how a set of items are stored
Unique identifier field for Package’s structure
Package name description
Total quantity of packages inside the package structure
"package":
"id": "000002",
"name": "Soda",
"count": 1
container
name
returnable
size
unitOfMeasurement
Array structure to describe the way an item is laid up
Container name, usually describes container’s type: bottle, can, etc.
Boolean field to indicates if an item is from returnable type
The container’s size, directly related with the unit of measurement field
Container’s unit of measurement, directly related with the "size” field
"container":
"name": "LATA",
"returnable": false,
"size": 350,
"unitOfMeasurement": "ML/CCM"
There are also fields that can only be updated by relay and others by the CMS tools, following below a set of the most important: