REQUEST PROPERTIES

Property BEES Customer BEES Care BEES Grow BEES Force BEES Partner
Required
Description Example
id string false false false false true Represents each item instance. Key of items collection
Allowed Values:
Default:
REGULAR
agingGroup string false false false false Used for FIFO sales, advanced date product.
Allowed values: ORANGE / REGULAR / YELLOW
Default:
Regular
Regular
casingDescriptionTemplate string false false false false Modifies how the item's price description is displayed in the catalog and Product details Page.
Allowed values: PACKAGE_QTY_ITEM_CONTAINER_INFO / PACKAGE_QTY_ITEM_SIZE / PACKAGE_QTY_SIZE
PACKAGE_QTY_ITEM_CONTAINER_INFO
brandId string false false false false Used in search inside category.
number of characters: >= 1 and <= 255
B_0001
brandName string false false false false Used in search inside category.
number of characters: >= 1 and <= 255
SKOL
subBrandName string false false false false Used in search inside category. Product associated with the main brand that have specific identity. Currently, this field is used only by CO, DO, EC, PE and ZA PURE MALT
image string false false false false The image URL received from the RAS http://englishversion
palletQuantity integer false false false false Field used to inform the quantity of pallets per SKU. Currently, it is used only by ZA.
>= 0
10
salesRanking integer false false false false The position of this item in the sales ranking. This is used to allow B2B to sort the items by top sellers. Lower numbers should correspond to greater sellers (1 should by the most top seller, 2 the second one, and so on.
2
variableWeight boolean false false false false If the weight is variable. false
upc string false false false false Used in Product details Page, This field is the bar code, sent by the zone via Relay. 1845689031101
supplier string false false false false Used in Product details Page, item supplier. Supplier
countryOfOrigin string false false false false Used in Product details Page, country of origin. Supplier
upcCase string false false false false Used in Product details Page, product package barcode. 1845678901001
upcUnit string false false false false Used in Product details Page, unit of measurement. ml
ozVolume number false false false false Used in Product details Page, Volume measure. 375
abv number false false false false Used in Product details Page, percentage by volume of amount alcohol in the item. 25
ibu number false false false false Used in Product details Page, percentage bitterness scale. 25
description string false false false false Used in Product details Page, a brief historical description of item. The name Budweiser is a German derivate adjective, meaning 'of Budweis'.
styleType string false false false false Used in Product details Page, this item style of the product, used to categorize and filter. Currently, this filter is used only by US. IPA
distributorProductType string false false false false Used in Product details Page, the item distributor product type information. TODO
itemType string false false false false Used in Product details Page, the item type, for example: 'beer', 'wine', 'water', 'juice'. beer
uncategorized boolean false false false false Used in Product details Page, products without attributes,, that are not possible to categorize. false
productClass string false false false false Used in Product details Page, product class. alcoholDrinks
enabled boolean false false false false Used in Product details Page, defines if the item is enabled or not. false
variant boolean false false false false Used in Nestlé Brazil box layout. The SKU has variant and was grouped into different vendor item ids. false
vendorID string true Used to identify items sold by Nestlé.