- Request
- Path parameters
- Query parameters
- CatalogLanguageType
- Body
- UpdateOfferMappingDTO
- UpdateOfferDTO
- UpdateMappingDTO
- BasePriceDTO
- AgeDTO
- UpdatePriceWithDiscountDTO
- CommodityCodeDTO
- OfferConditionDTO
- DeleteOfferParameterType
- TimePeriodDTO
- OfferManualDTO
- ParameterValueDTO
- OfferParamDTO
- OfferType
- OfferWeightDimensionsDTO
- CurrencyType
- AgeUnitType
- CommodityCodeType
- OfferConditionQualityType
- OfferConditionType
- TimeUnitType
- Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 423 Locked
- 500 Internal Server Error
Adding products to the catalog and changing information about them
The method is available for all models.
If you are using an API Key token, one of the accesses in the list is required to call the method
- offers-and-cards-management — Manage products and cards
- all-methods — Full account management
Adds products to the catalog and transmits:
- their categories on the Market and categorical characteristics;
- main features;
- prices of goods in the cabinet.
It also combines products on the card, edits and deletes information about already added products, including prices in the cabinet and product categories.
You can get a list of Market categories using a request. POST categories/tree, and product characteristics by category using POST category/{categoryId}/parameters.
Add a new product
Transfer it with a new ID that has never been used in the folder before.
Be sure to specify the parameters: offerId, name, marketCategoryId, pictures, vendor, description.
Try to convey as much information as possible right away. The Market will need it to select a suitable card or create a new one.
If you know which card on the Market corresponds to the product, you can immediately specify the ID of this card (SKU on the Market) in the field marketSKU.
For sellers of the Yandex Go Market:
When you add products to the catalog, specify the parameter values name and description in Russian. To display them in a different language on the showcase, make the request again. POST businesses/{businessId}/offer-mappings/update where to specify:
- the language in the parameter
language; - parameter values
nameanddescriptionin the specified language.
You do not need to retransmit the remaining product characteristics.
Change product information
Send the new data by specifying in offerId appropriate your SKU.
Fields where nothing changes can be omitted.
Delete previously transmitted product parameters
In deleteParameters specify the values of the parameters that you want to delete. You can pass multiple values at once.
For parameters with the type string you can also pass an empty value.
Parameter offerId must be unique for all the products that you transfer.
SKU Usage Rules
-
Each product must have its own SKU.
-
An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.
The data in the catalog is not updated instantly
It takes up to a few minutes.
| , Limit: 10,000 products per minute, no more than 100 products per request |
|---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. To find out the ID, use the request GET campaigns. ℹ️ What is a cabinet and a store on the Market?
Min value: |
Query parameters
|
Name |
Description |
|
language |
Type: CatalogLanguageType The language in which the values in the parameters are accepted and returned Default value: |
CatalogLanguageType
Language:
RU— Russian.UZ— Uzbek.
|
Type |
Description |
|
Enum: |
Body
application/json
{
"offerMappings": [
{
"offer": {
"offerId": "string",
"name": "Ударная дрель Makita HP1630, 710 Вт",
"marketCategoryId": 0,
"category": "string",
"pictures": [
"string"
],
"videos": [
"string"
],
"manuals": [
{
"url": "string",
"title": "string"
}
],
"vendor": "LEVENHUK",
"barcodes": [
46012300000000
],
"description": "string",
"manufacturerCountries": [
"Россия"
],
"weightDimensions": {
"length": 65.55,
"width": 50.7,
"height": 20,
"weight": 1.001
},
"vendorCode": "VNDR-0005A",
"tags": [
"до 500 рублей"
],
"shelfLife": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "string"
},
"lifeTime": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "string"
},
"guaranteePeriod": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "string"
},
"customsCommodityCode": 8517610008,
"commodityCodes": [
{
"code": "string",
"type": "CUSTOMS_COMMODITY_CODE"
}
],
"certificates": [
"string"
],
"boxCount": 0,
"condition": {
"type": "PREOWNED",
"quality": "PERFECT",
"reason": "string"
},
"type": "DEFAULT",
"downloadable": false,
"adult": false,
"age": {
"value": 0,
"ageUnit": "YEAR"
},
"params": [
{
"name": "Wi-Fi",
"value": "есть"
}
],
"parameterValues": [
{
"parameterId": 0,
"unitId": 0,
"valueId": 0,
"value": "string"
}
],
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0
},
"purchasePrice": {
"value": 0,
"currencyId": "RUR"
},
"additionalExpenses": {
"value": 0,
"currencyId": "RUR"
},
"cofinancePrice": {
"value": 0,
"currencyId": "RUR"
},
"firstVideoAsCover": false,
"deleteParameters": [
"ADDITIONAL_EXPENSES"
]
},
"mapping": {
"marketSku": 0
}
}
],
"onlyPartnerMediaContent": false
}
|
Name |
Description |
|
offerMappings* |
Type: UpdateOfferMappingDTO[] A list of products that need to be added or updated. Min items: Max items: |
|
onlyPartnerMediaContent |
Type: boolean Whether only the product data you provided will be used. Default value: |
UpdateOfferMappingDTO
Product information.
|
Name |
Description |
|
offer* |
Type: UpdateOfferDTO Product parameters. |
|
mapping |
Type: UpdateMappingDTO Information about the product card on the Market. |
UpdateOfferDTO
Product parameters.
|
Name |
Description |
|
offerId* |
Type: string Your SKU is the product identifier in your system. SKU Usage Rules:
The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: Max length: Pattern: |
|
additionalExpenses |
Type: BasePriceDTO The price of the product. |
|
adult |
Type: boolean The parameter includes the label 18+ for the product. Set it only for products that are related to satisfying sexual needs. |
|
age |
Type: AgeDTO If the product is not intended for children under a certain age, please indicate this. The age limit can be set in years (from zero, from 6, 12, 16 or 18) or in months (any number from 0 to 12). |
|
barcodes |
Type: string[] Specify it as a sequence of numbers. Suitable codes are EAN-13, EAN-8, UPC-A, UPC-E or Code 128. For books, specify the ISBN. For products certain categories and brands The barcode must be a valid GTIN code. Please note: Internal barcodes starting with 2 or 02 and Code 128 format codes are not GTINs. What is GTIN? Example: Min items: |
|
basicPrice |
Type: UpdatePriceWithDiscountDTO Price with discount indication. |
|
boxCount |
Type: integer<int32> The number of cargo spaces. This parameter is used if the product consists of several boxes, packages, and so on. For example, an air conditioner takes up two spaces — an external and an internal unit in two boxes. For products that occupy one place, do not pass this parameter. |
|
category ⦸
|
Type: string This parameter is deprecated. Instead, use The product category in your store. |
|
certificates |
Type: string[] The numbers of the documents for the product: certificate, declaration of conformity, etc. You can only transfer the numbers of the documents, the scans of which are uploaded in the merchant's office by Instructions.
Min items: |
|
cofinancePrice ⦸
|
Type: BasePriceDTO The price of the product. |
|
commodityCodes |
Type: CommodityCodeDTO[] Product codes.
Min items: |
|
condition |
Type: OfferConditionDTO The condition of the discounted product. It is only used for products sold at a markdown. |
|
customsCommodityCode ⦸
|
Type: string This parameter is deprecated. Instead, use The product code in the unified Commodity Nomenclature of Foreign Economic Activity (HS) is 10 or 14 digits without spaces. Be sure to indicate if there is one. Example: |
|
deleteParameters |
Type: DeleteOfferParameterType[] The parameters that you previously passed to If you send You can pass multiple values at once. Do not use together with the corresponding parameter in
Enum: Min items: Unique items |
|
description |
Type: string Detailed product description: for example, its advantages and features. Do not provide installation and assembly instructions in the description. Do not use the words "discount", "sale", "cheap", "gift" (except gift categories), "free", "special offer", "special price", "novelty", "new", "analog", "order", "hit". Do not provide any contact information or links. You can use the following tags:
The optimal length is 400-600 characters. Max length: |
|
downloadable |
Type: boolean A sign of a digital product. Specify |
|
firstVideoAsCover |
Type: boolean Use the first video in the card as a video background. Pass it on |
|
guaranteePeriod |
Type: TimePeriodDTO The warranty period is the period during which the product can be replaced or repaired at no additional cost. Be sure to specify the deadline, if any. In the comments, describe the features of the warranty service. For example, |
|
lifeTime |
Type: TimePeriodDTO Service life is the period during which a product must perform its function properly. Be sure to specify the deadline, if any. Specify the storage conditions in the comments. For example, |
|
manuals |
Type: OfferManualDTO[] A list of instructions for using the product. The maximum number of instructions is 6.
Min items: Max items: |
|
manufacturerCountries |
Type: string[] The country where the product was produced. Write down the names of the countries as they are written in the list.
Example: Min items: |
|
marketCategoryId |
Type: integer<int64> The ID of the category on the Market to which you attribute your product. When changing the category, make sure that the product characteristics and their values in the parameter You can get a list of Market categories using a request. POST categories/tree. |
|
name |
Type: string Make up the name according to the scheme: type + brand or manufacturer + model + features, if any (for example, color, size or weight) and quantity in the package. Do not include emotional characteristics ("hit", "super", etc.) in the name of the terms of sale (for example, "discount", "free shipping", etc.). Do not write words in capital letters, except for the established names of brands and models. The optimal length is 50-60 characters. Example: Max length: |
|
parameterValues |
Type: ParameterValueDTO[] A list of characteristics with their values. With By change pass only those characteristics whose value needs to be updated. If in To delete the value of the specified characteristic, transmit it The maximum number of characteristics is 300.
You can specify multiple values of the same characteristic, provided that:
To do this, in Min items: Max items: |
|
params ⦸
|
Type: OfferParamDTO[] This parameter is deprecated. When transmitting characteristics, use Characteristics that only products of a specific category have, such as the diameter of bicycle wheels or the material of shoe soles.
If the product has several values of the same parameter, send them with the same ExampleMin items: |
|
pictures |
Type: string[] Links to product images. The image on the first link is considered the main one, the others are additional. Link Requirements
✅ ✅ ❌ ❌ The links to the image must be permanent. You cannot use dynamic links that change from upload to upload. If you need to replace the image, upload the new image via a new link, and delete the link to the old one. If you simply replace the image using the old link, it will not update. Min items: |
|
purchasePrice |
Type: BasePriceDTO The price of the product. |
|
shelfLife |
Type: TimePeriodDTO Expiration date is the period after which the product becomes unusable. Specify the date indicated on the jar or package. The current date, delivery date, or shipment date does not matter. Be sure to specify the deadline, if any. Specify the storage conditions in the comments. For example, |
|
tags |
Type: string[] Product labels that the store uses. The tags are not visible to customers. You can group and filter different products in the catalog by tags, for example, products of the same series, collection, or line. The maximum tag length is 20 characters. One product can have a maximum of 10 tags. In total, you can create no more than 50 different tags.
Example: Min items: |
|
type |
Type: OfferType A special type of product. It is indicated if the product:
Enum: |
|
vendor |
Type: string The name of the brand or manufacturer. It should be written the way the brand itself writes it. Example: |
|
vendorCode |
Type: string The article of the product from the manufacturer. Example: |
|
videos |
Type: string[] Links (URLs) to the product video. The maximum number of links is 6. Link Requirements
✅ ✅ ❌ ❌ Links to videos must be permanent. You cannot use dynamic links that change from upload to upload. If you need to replace the video, upload the new video via a new link, and delete the link to the old one. If you just replace the video using the old link, it will not update. Min items: Max items: |
|
weightDimensions |
Type: OfferWeightDimensionsDTO The dimensions of the package and the weight of the product. |
UpdateMappingDTO
A card on the Market that, from your point of view, fits the product. To determine the ID of the appropriate card, use the search in the cabinet (Products → Catalog → Upload products).
Based on the verification results, the Market can link the product to a more suitable card.
|
Name |
Description |
|
marketSku |
Type: integer<int64> The ID of the card on the Market. Min value: |
BasePriceDTO
The price of the product.
|
Name |
Description |
|
currencyId* |
Type: CurrencyType Currency. Enum: |
|
value* |
Type: number Meaning. Min value (exclusive): |
AgeDTO
Age in the specified units of measurement.
|
Name |
Description |
|
ageUnit* |
Type: AgeUnitType Unit of measurement. Enum: |
|
value* |
Type: number Meaning. Min value: |
UpdatePriceWithDiscountDTO
Price with discount indication.
|
Name |
Description |
|
currencyId* |
Type: CurrencyType Currency. Enum: |
|
value* |
Type: number Meaning. Min value (exclusive): |
|
discountBase |
Type: number The crossed-out price. The number must be an integer. You can specify a price with a discount from 5 to 99%. Pass this parameter every time the price is updated if you provide a discount on the product. Min value (exclusive): |
CommodityCodeDTO
Product code.
|
Name |
Description |
|
code* |
Type: string Product code. |
|
type* |
Type: CommodityCodeType The type of product code. Enum: |
OfferConditionDTO
The condition of the discounted product.
|
Name |
Description |
|
quality |
Type: OfferConditionQualityType The appearance of the product. Enum: |
|
reason |
Type: string Product description. Describe the defects in detail, how noticeable they are and where to look for them. |
|
type |
Type: OfferConditionType The type of markdown. Enum: |
DeleteOfferParameterType
The values of the parameters you want to delete and the corresponding parameters in UpdateOfferDTO in which you passed these values earlier:
ADDITIONAL_EXPENSES— additional costs for the product (parameteradditionalExpenses).ADULT— mark 18+ (parameteradult)AGE— age limit for children (parameterage).BARCODES— barcode (parameterbarcodes).BOX_COUNT— the number of cargo spaces (parameterboxCount).CERTIFICATES— document numbers for the product (parametercertificates).COFINANCE_PRICE— the price for discounts with Yandex.Market (parametercofinancePrice).COMMODITY_CODES— product codes (parametercommodityCodes).CONDITION— the condition of the discounted product (parametercondition).CUSTOMS_COMMODITY_CODE— the product code in the HS code (parametercustomsCommodityCode).DESCRIPTION— product description (parameterdescription).DOWNLOADABLE— digital product attribute (parameterdownloadable).FIRST_VIDEO_AS_COVER— using the first video in the card as a video background (parameterfirstVideoAsCover).GUARANTEE_PERIOD— warranty period (parameterguaranteePeriod).LIFE_TIME— service life (parameterlifeTime).MANUALS— a list of instructions for using the product (parametermanuals).MANUFACTURER_COUNTRIES— country of manufacture (parametermanufacturerCountries).PARAMETERS— product characteristics (parametersparams,parameterValues).PICTURES— links to product images (parameterpictures).PURCHASE_PRICE— cost price (parameterpurchasePrice).SHELF_LIFE— expiration date (parametershelfLife).TAGS— product tags that the store uses (parametertags).TYPE— a special type of product (parametertype).VENDOR_CODE— the name of the brand or manufacturer (parametervendorCode).VIDEOS— links to the product video (parametervideos).
|
Type |
Description |
|
Enum: |
TimePeriodDTO
A time period with a comment. The requirements for the comment content depend on the context of the parameter usage and are specified in the description of the field that contains it.
|
Name |
Description |
|
timePeriod* |
Type: integer Duration in the specified units. |
|
timeUnit* |
Type: TimeUnitType Unit of measurement. Enum: |
|
comment |
Type: string Comment. |
OfferManualDTO
Instructions for using the product.
|
Name |
Description |
|
url* |
Type: string Link to the instructions. |
|
title |
Type: string The name of the instruction that will be displayed on the product card. |
ParameterValueDTO
The value of the characteristic.
You can specify multiple values of the same characteristic, provided that:
- Type of feature —
ENUM. - In response to the request POST category/{categoryId}/parameters this characteristic has a field
multivalueit matterstrue.
To do this, in parameterValues pass each value separately — multiple objects with parameters parameterId, valueId and value. Parameter parameterId it must be the same.
|
Name |
Description |
|
parameterId* |
Type: integer<int64> The identifier of the characteristic. Min value: |
|
unitId |
Type: integer<int64> ID of the unit of measurement. If you did not pass the parameter |
|
value |
Type: string Meaning. |
|
valueId |
Type: integer<int64> ID of the value. Be sure to specify the identifier if you are transmitting a value from the list of acceptable values received from the Market. Only for type characteristics |
OfferParamDTO
Product parameters.
If the product has several values of the same parameter, send them with the same name, but different value.
Example
"params": [
{
"name": "Цвет для фильтра",
"value": "Зеленый"
},
{
"name": "Цвет для фильтра",
"value": "Желтый"
}
]
|
Name |
Description |
|
name* |
Type: string Title. It must match the name of the feature on the Market. You can find it from the category's Excel template or through a query. POST category/{categoryId}/parameters. Example: |
|
value* |
Type: string Meaning. Example: |
OfferType
Special type of product:
DEFAULT— products for which you transferred a special type earlier and want to remove it.MEDICINE— medicines.BOOK— paper and electronic books.AUDIOBOOK— Audiobooks.ARTIST_TITLE— music and video production.ON_DEMAND— custom-made products.ALCOHOL— alcohol.
If your product is a book
Specify the year of publication in the product specifications. More information about the parameter
|
Type |
Description |
|
Enum: |
OfferWeightDimensionsDTO
The dimensions of the package and the weight of the product.
If the product takes up several boxes, fold them compactly before measuring the dimensions.
|
Name |
Description |
|
height* |
Type: number Package height in cm. Example: |
|
length* |
Type: number Package length in cm. Example: |
|
weight* |
Type: number The weight of the product in kg, including packaging (gross). Example: |
|
width* |
Type: number Package width in cm. Example: |
CurrencyType
Currency codes. Possible values:
RUR— the Russian ruble.UAH— the Ukrainian hryvnia.BYR— Belarusian ruble.KZT— Kazakhstani tenge.UZS— Uzbek sum.
|
Type |
Description |
|
Enum: |
AgeUnitType
Age measurement units:
YEAR— a year.MONTH— a month.
|
Type |
Description |
|
Enum: |
CommodityCodeType
Type of product code:
CUSTOMS_COMMODITY_CODE— the product code in the unified Commodity nomenclature of Foreign Economic Activity (HS) is 10 or 14 digits without spaces.IKPU_CODE— the identification code of products and services in Uzbekistan is 17 digits without spaces.
Do not send multiple codes of the same type.
|
Type |
Description |
|
Enum: |
OfferConditionQualityType
Product appearance:
PERFECT— perfect.EXCELLENT— Excellent.GOOD—A good one.NOT_SPECIFIED— not selected.
|
Type |
Description |
|
Enum: |
OfferConditionType
Markdown type:
PREOWNED— used goods that used to belong to another person.SHOWCASESAMPLE— showcase sample.REFURBISHED— re-sale of the product.REDUCTION— defective product.RENOVATED— restored product.NOT_SPECIFIED— not selected.
REFURBISHED — special value for clothes, shoes and accessories. It is used only for discounted products from this category. Other values for clothing, shoes, and accessories are not used.
|
Type |
Description |
|
Enum: |
TimeUnitType
Time measurement unit:
HOUR"An hour."DAY— a day.WEEK— a week.MONTH— a month.YEAR— a year.
|
Type |
Description |
|
Enum: |
Responses
200 OK
The request was executed correctly, and the data has been processed.
The answer 200 by itself does not mean that the transmitted values are correct.
Be sure to look at the details of the response.: status and a list of errors, if any.
Even if an error is made in the characteristics of just one product, no changes from the request will be included in the catalog.
Body
application/json
{
"status": "OK",
"results": [
{
"offerId": "string",
"errors": [
{
"type": "UNKNOWN_CATEGORY",
"parameterId": 0,
"message": "string"
}
],
"warnings": [
{
"type": "UNKNOWN_CATEGORY",
"parameterId": 0,
"message": "string"
}
]
}
]
}
|
Name |
Description |
|
results |
Type: UpdateOfferMappingResultDTO[] Errors and warnings that appeared when processing the list of characteristics. Each item in the list corresponds to one product. If there are no errors or warnings, the field is not passed.
Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
UpdateOfferMappingResultDTO
Errors and warnings that appeared due to the transmitted characteristics.
|
Name |
Description |
|
offerId* |
Type: string Your SKU is the product identifier in your system. SKU Usage Rules:
The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: Max length: Pattern: |
|
errors |
Type: OfferMappingErrorDTO[] Mistakes. If there is an error for at least one product, the information in the catalog will not be updated for all transferred products.
Min items: |
|
warnings |
Type: OfferMappingErrorDTO[] Warnings. The information in the catalog will be updated.
Min items: |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
OfferMappingErrorDTO
The text of the error or warning.
|
Name |
Description |
|
message* |
Type: string The text of the error or warning. |
|
type* |
Type: OfferMappingErrorType Types of errors and warnings:
You can check which category characteristics are available for a given category and get their settings using a request. POST category/{categoryId}/parameters. Enum: |
|
parameterId |
Type: integer<int64> ID of the feature that the error or warning is associated with. |
OfferMappingErrorType
Types of errors and warnings:
UNKNOWN_CATEGORY— an unknown category is specified.INVALID_CATEGORY— a non-leaf category is specified. Specify the one that has no child categories.EMPTY_MARKET_CATEGORY— the Market category is not specified when transmitting the category characteristics.UNKNOWN_PARAMETER— a characteristic has been transmitted that is not among the characteristics of the category.UNEXPECTED_BOOLEAN_VALUE— something else is passed instead of the boolean value.NUMBER_FORMAT— a string was passed that does not represent a number, instead of a number.INVALID_UNIT_ID— a unit of measurement that is unacceptable for the characteristic has been passed.INVALID_GROUP_ID_LENGTH— the name exceeds the allowed character value of 255.INVALID_GROUP_ID_CHARACTERS— transferred invalid characters.INVALID_PICKER_URL— a link to the thumbnail image has been transmitted, which is not included in the transmitted links to the product image.LOCKED_DIMENSIONS— the dimensions of the package have been transferred, which cannot be changed.INVALID_COMMODITY_CODE— an incorrect product code has been transmitted.
You can check which category characteristics are available for a given category and get their settings using a request. POST category/{categoryId}/parameters.
|
Type |
Description |
|
Enum: |
400 Bad Request
The request contains incorrect data.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
|
Name |
Description |
|
code* |
Type: string The error code. |
|
message |
Type: string Description of the error. |
401 Unauthorized
The authorization data is not specified in the request.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
404 Not Found
The requested resource was not found.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
420 Method Failure
The resource access limit has been exceeded.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
423 Locked
The specified method cannot be applied to the resource.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal server error.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.
What is GTIN?
GTIN is a unique number assigned to a product in a single international database. GS1. This number generates an EAN, UPC, or ISBN barcode.
How to make sure that the product is in the database
You can check the code on verification page on the GS1 association's website. If the product is not found, request the GTIN code from your supplier.
How to get a GTIN for your products
To receive GTIN codes, the manufacturer needs to join the GS1 association and register the products.
ASCII characters 0 through 31 (except 9) and 127 are prohibited. from the table.