❗️ Brand product information

Method for retrieving product information by brand.

Request

GET

/nomenclature/composition

Headers

Name

Description

Authorization*

Type: string

Token received in response to the /security/oauth/token request

Responses

200 OK

Current brand nomenclature.

Body

application/json

{
    "categories": [
        {
            "id": "some-uniq-identifier",
            "name": "Milk'",
            "parentId": "some-uniq-identifier"
        }
    ],
    "items": [
        {
            "barcode": {
                "type": "ean13",
                "value": "987654321098",
                "values": [
                    "987654321098",
                    "987654321099",
                    "987654321000"
                ],
                "weightEncoding": "ean13-tail-gram-4"
            },
            "categoryId": "some-uniq-identifier",
            "description": {
                "composition": "normalised milk (whole milk, skimmed milk)",
                "expiresIn": "60",
                "general": "string",
                "nutritionalValue": "600 kcal, 8g protein, 3.2g fat, 40g carbohydrates",
                "packageInfo": "carton",
                "purpose": "string",
                "storageRequirements": "from −5 to 5 degrees Celsius",
                "vendorCountry": "Russia",
                "vendorName": "Dairy Plant LLC"
            },
            "exciseValue": "ССН",
            "id": "some-uniq-identifier",
            "images": [
                {
                    "order": 0,
                    "url": "https://ya.ru/images/image_1.jpg"
                }
            ],
            "isCatchWeight": false,
            "labels": [
                "adult",
                "prescription"
            ],
            "limitPerOrder": 3,
            "markingType": "default",
            "measure": {
                "quantum": 0.3,
                "unit": "GRM",
                "value": 1000
            },
            "name": "Milk",
            "vat": -1,
            "vendorCode": "string",
            "vendorInn": "string",
            "volume": {
                "unit": "DMQ",
                "value": 100
            }
        }
    ]
}

Name

Description

items*

Type: BrandItems[]

Brand product list

BrandItems

Brand product list

Name	Description
barcode*	Type: Barcode Product barcode
description*	Type: ItemDescription Product description
id*	Type: string Internal unique product identifier in the Partner’s system Example: `some-uniq-identifier` Max length: `64`
images*	Type: BrandImages[] Product image
isCatchWeight*	Type: boolean Parameter indicating whether the product is catch-weight or not. For catch-weight products it is `true`.
measure*	Type: Measure Product measurement characteristic, e.g., weight or volume
name*	Type: string Product name Example: `Milk`
vendorCode*	Type: string Product article in the Partner’s system.
categoryId	Type: string Internal unique category identifier in the Partner’s system from the #/categories block. Example: `some-uniq-identifier` Max length: `64`
exciseValue	Type: string Excise type. Example, ССН (Cyrillic; stands for “сахаросодержащие напитки”, sugar-containing beverages). Enum: `ССН`
labels	Type: string[] List of special product characteristics. For example, `For adults`, `Alcohol`, `Private label`, `Prescription` and others. Partner can add their own values after coordinating them with their Yandex Eats manager: adult – adult product. prescription – prescription product. pickup – available for pickup only. delivery – available for delivery only. all – available for delivery and pickup only. energy_drink – energy drinks. frozen – frozen products. alcoholic – alcohol. own_brand – private label. thermolabile – thermolabile products. vital – vital and essential medicines. Example: `adult,prescription`
limitPerOrder	Type: integer Order quantity limit per order (per customer). Only for special cases of high demand or temporary promotions. For catch-weight products it is calculated as 'how many product quanta can be put in the cart'. Example: `3`
markingType	Type: string Type of mandatory product marking. Example: `default`
vat	Type: integer VAT included in the cost, as a percentage. Available values: `20`, `10`, `7`, `5` or `-1`. For VAT-free tax rate pass `-1`. `0` is an invalid value. Example: `-1`
vendorInn	Type: string Passed only in rare cases when products from different sellers with different details are placed in one store. When passing INN per product, verify that you provide data for the entire assortment, not selectively. If all products of your brand in the receipt are sold by a single seller, passing the INN value in the /composition method is not required.
volume	Type: Volume Volume occupied by the product. Useful for delivery calculation. Can significantly differ from the nominal product volume. For example, gift sets, large packages.

NomenclatureCategories

Product categories.

Name	Description
id*	Type: string Internal unique category identifier in the Partner’s system Example: `some-uniq-identifier` Max length: `64`
name*	Type: string Category name. Example: `Milk'`
parentId	Type: string Internal unique identifier of the parent category in the Partner’s system for tree structure. Example: `some-uniq-identifier` Max length: `64`

Barcode

Product barcode

Name	Description
type*	Type: string Barcode type Example: `ean13` Enum: `auspost`, `ausredirect`, `ausreply`, `ausroute`, `aztec`, `c25iata`, `c25ind`, `c25inter`, `c25logic`, `c25matrix`, `codabar`, `codablockf`, `code11`, `code100`, `code128`, `code128b`, `code16k`, `code39`, `code49`, `code93`, `daft`, `datamatrix`, `dotcode`, `dpident`, `dpleit`, `ean128`, `ean13`, `ean14`, `eanx`, `eanx_chk`, `excode39`, `fim`, `flat`, `hanxin`, `hibc_128`, `hibc_39`, `hibc_aztec`, `hibc_blockf`, `hibc_dm`, `hibc_micpdf`, `hibc_pdf`, `hibc_qr`, `isbnx`, `itf14`, `japanpost`, `kix`, `koreapost`, `logmars`, `mailmark`, `maxicode`, `micropdf417`, `microqr`, `msi_plessey`, `nve18`, `onecode`, `pdf417`, `pdf417trunc`, `pharma`, `pharma_two`, `planet`, `plessey`, `postnet`, `pzn`, `qrcode`, `rm4scc`, `rss14`, `rss14stack`, `rss14stack_omni`, `rss_exp`, `rss_expstack`, `rss_ltd`, `telepen`, `telepen_num`, `upca`, `upca_chk`, `upce`, `upce_chk`, `vin`
value*	Type: string Product barcode. If there’s no barcode in the Partner’s system, then you can pass a random number (unique for each product) Example: `987654321098`
weightEncoding*	Type: string Weight encoding algorithm in the barcode Example: `ean13-tail-gram-4` Enum: `none`, `ean13-tail-gram-4`, `ean13-tail-gram-5`
values	Type: string[] List of product barcodes Example: `987654321098,987654321099,987654321000`

ItemDescription

Product description

Name	Description
composition	Type: string Composition information Example: `normalised milk (whole milk, skimmed milk)`
expiresIn	Type: string Shelf life in days Example: `60`
general	Type: string General product description
nutritionalValue	Type: string Nutritional value Example: `600 kcal, 8g protein, 3.2g fat, 40g carbohydrates`
packageInfo	Type: string Package information Example: `carton`
purpose	Type: string Purpose
storageRequirements	Type: string Storage requirements Example: `from −5 to 5 degrees Celsius`
vendorCountry	Type: string Country of origin Example: `Russia`
vendorName	Type: string Producer Example: `Dairy Plant LLC`

BrandImages

Name

Description

url*

Type: string<uri>

Link to product image for download

Example: https://ya.ru/images/image_1.jpg

order

Type: integer

Ascending sort order

Example: 0

Min value: 0

Measure

Product measurement characteristic, e.g., weight or volume

Name	Description
unit*	Type: string Unit of measurement. MLT – milliliters, GRM – grams. Example: `GRM` Enum: `MLT`, `GRM`
value*	Type: integer Measurement value. For catch-weight products pass 1000. For unit products, use the actual product weight. Example: `1000`
quantum	Type: number<float> Smallest quantity of product (quantum) available for ordering. Value is calculated from `value`. Must be filled for catch-weight products (`isCatchWeight=true`). The example shows how to pass a quantum equal to 300 grams. Example: `0.3`

Volume

Volume occupied by the product. Useful for delivery calculation. Can significantly differ from the nominal product volume. For example, gift sets, large packages.

Name

Description

unit*

Type: string

Volume measurement unit

Example: DMQ

Enum: CMQ, DMQ

value*

Type: integer

Volume value

Example: 100

Min value: 1

400 Bad Request

Request error. The response is expected to contain an array with an object from the error list.

Body

application/json

[
    {
        "code": 400,
        "description": "Description of error"
    }
]

ErrorItem[]

ErrorItem

Name

Description

code*

Type: integer

Numeric error code agreed with Yango Deli.

Example: 400

description*

Type: string

Error description

Example: Description of error

401 Unauthorized

Authorisation failed.

Body

application/json

{
    "reason": "Access token has been expired. You should request a new one"
}

Name

Description

reason*

Type: string

The reason why authorisation failed.

Example: Access token has been expired. You should request a new one

500 Internal Server Error

Internal server errors. The response is expected to contain an array with an object from the error list.

Body

application/json

[
    {
        "code": 400,
        "description": "Description of error"
    }
]

ErrorItem[]

Was the article helpful?

Product information

❗️ Product stock