Recommended product cards

Deprecated

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

Returns the IDs of the product cards on the Market that are recommended for your products.

Each product that you place must have a product card on the Market with its own identifier — SKU on the Market. It is indicated in the URL of the product card, after "...sku=", for example:

https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…

To get the recommended SKUs on the Market for products, send as much information about them as possible in the body of the POST request: names, manufacturers, barcodes, prices, etc.

The received SKUs can be sent along with information about your products via a request. POST businesses/{businessId}/offer-mappings/update.

You can get up to 500 recommendations per request.

, Limit: 100,000 recommendations per hour

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries/suggestions

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

  • Modules and APIs → block Sending data to Yandex.Market.
  • Query log → drop-down list in the block Show logs.

, Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

Min value: 1

Body

application/json
{
    "offers": [
        {
            "name": "Ударная дрель Makita HP1630, 710 Вт",
            "shopSku": "string",
            "category": "string",
            "vendor": "LEVENHUK",
            "vendorCode": "VNDR-0005A",
            "description": "string",
            "id": "string",
            "feedId": 0,
            "barcodes": [
                46012300000000
            ],
            "urls": [
                "string"
            ],
            "pictures": [
                "string"
            ],
            "manufacturer": "string",
            "manufacturerCountries": [
                "string"
            ],
            "minShipment": 0,
            "transportUnitSize": 0,
            "quantumOfSupply": 0,
            "deliveryDurationDays": 0,
            "boxCount": 0,
            "customsCommodityCodes": [
                "string"
            ],
            "weightDimensions": {
                "length": 65.55,
                "width": 50.7,
                "height": 20,
                "weight": 1.001
            },
            "supplyScheduleDays": [
                "MONDAY"
            ],
            "shelfLifeDays": 0,
            "lifeTimeDays": 0,
            "guaranteePeriodDays": 0,
            "processingState": {
                "status": "UNKNOWN",
                "notes": [
                    {
                        "type": "ASSORTMENT",
                        "payload": "string"
                    }
                ]
            },
            "availability": "ACTIVE",
            "shelfLife": {
                "timePeriod": 0,
                "timeUnit": "HOUR",
                "comment": "string"
            },
            "lifeTime": {
                "timePeriod": 0,
                "timeUnit": "HOUR",
                "comment": "string"
            },
            "guaranteePeriod": {
                "timePeriod": 0,
                "timeUnit": "HOUR",
                "comment": "string"
            },
            "certificate": "string",
            "price": 0
        }
    ]
}

Name

Description

offers*

Type: MappingsOfferDTO[]

The list of products.
Information about the products in the catalog.
Basic information about the products in the catalog.

Min items: 1

Max items: 500

MappingsOfferDTO

Information about the products in the catalog.

Name

Description

availability

Type: OfferAvailabilityStatusType

Delivery plans:

  • ACTIVE — there will be supplies.
  • INACTIVE — there will be no deliveries: the product is in stock, but you no longer plan to deliver it. 60 days after the product runs out of stock, this status will change to DELISTED.
  • DELISTED — archive: the product has run out of stock, and there will be no more deliveries. If the product is returned to the warehouse (for example, the customer returns the order), this status will change to INACTIVE.

Enum: ACTIVE, INACTIVE, DELISTED

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: 46012300000000

Min items: 1

Unique items  

boxCount

Type: integer<int32>

How many seats (if more than one) the product occupies.

The parameter is specified only if the product occupies more than one place (for example, the air conditioner occupies two places: an external and an internal unit in two boxes). If the product occupies one place, do not specify this parameter.

category

⦸

Type: string

Instead, use marketCategoryId.

The product category in your store.

certificate

Type: string

The document number for the product.

Before specifying the number, the document must be uploaded to the seller's account on the Market. Instruction manual

customsCommodityCodes

Type: string[]

The list of product codes in the unified Commodity nomenclature of foreign economic activity (HS).

A mandatory parameter if the product is subject to special accounting (for example, in the Mercury system as products of animal origin or in the Honest SIGN system).

It can contain only one nested HS code.

Min items: 1

Unique items  

deliveryDurationDays

Type: integer<int32>

The period for which the seller delivers the goods to the warehouse, in days.

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 HTML tags to format the text:

  • <h>, <h1>, <h2> and so on — for headings;
  • <br> and <p> — for line breaks.
  • <ol> — for a numbered list.
  • <ul> — for a bulleted list.
  • <li> — to create list items (must be inside <ol> or <ul>);
  • <div> is supported, but does not affect the text display.

The optimal length is 400-600 characters.

Recommendations and rules

Max length: 6000

feedId

Type: integer<int64>

The feed ID.

guaranteePeriod

Type: TimePeriodDTO

Information about the warranty period: during which period (in years, months, days, weeks, or hours) maintenance and repair of the product or a refund are possible, and the manufacturer or seller will be responsible for the defects of the product.

A required parameter if the product has a warranty period.

The product has a warranty period, but you won't specify it.

The product will be hidden from the Market.

guaranteePeriodDays

Type: integer<int32>

Product warranty period: how many days is it possible to service and repair the product or refund money, and the manufacturer or seller will be responsible for the defects of the product.

id

Type: string

Your SKU is the product identifier in your system.

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.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

lifeTime

Type: TimePeriodDTO

Service life information: for what period (in years, months, days, weeks, or hours) The product will perform its function properly, and the manufacturer will be responsible for its significant shortcomings.

A required parameter if the product has a service life.

The product has a service life, but you don't specify it.

The product will be hidden from the Market.

lifeTimeDays

⦸

Type: integer<int32>

Instead, use lifeTime. Using both parameters together will result in an error.

Service life: how many days the product will properly perform its function, and the manufacturer will be responsible for its significant shortcomings.

manufacturer

Type: string

Product manufacturer: the company that produced the product, its address and registration number (if any).

Optional parameter.

manufacturerCountries

Type: string[]

A list of countries where the product is manufactured.

Required parameter.

It must contain at least one, but not more than 5 countries.

Min items: 1

Max items: 5

Unique items  

minShipment

Type: integer<int32>

The minimum number of items that you deliver to the warehouse.

For example, if you supply baby food in batches of at least 10 boxes, and each box contains 6 jars, specify the value 60.

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.

Recommendations and rules

Example: Impact drill Makita HP1630, 710 W

Max length: 256

pictures

Type: string[]

Links (URLs) of product images in good quality.

You can specify up to 30 links. In this case, the image on the first link will be the main one. It is used as a product image in the Market search and on the product card. Other product images are available in the enlarged image view.

Min length: 1

Max length: 2000

Min items: 1

Max items: 30

Unique items false

price

Type: number

The price of the product.

processingState

Type: OfferProcessingStateDTO

Information about the publication status of the product on the Market.

quantumOfSupply

⦸

Type: integer<int32>

Additional batch: how many items can be added to the minimum quantity minShipment.

For example, if you supply baby food in batches of at least 10 boxes and want to add 2 boxes to the minimum batch, with 6 jars in each box, specify the value 12.

shelfLife

Type: TimePeriodDTO

Expiration date information: after what time (in years, months, days, weeks, or hours) the product will become unusable. For example, categories such as food and medicines have expiration dates.

A required parameter if the product has an expiration date.

The product has an expiration date, but you don't specify it.

The product will be hidden from the Market.

shelfLifeDays

⦸

Type: integer<int32>

Instead, use shelfLife. Using both parameters together will result in an error.

Expiration date: after how many days the product will become unusable.

shopSku

Type: string

Your SKU is the product identifier in your system.

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.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

supplyScheduleDays

Type: DayOfWeekType[]

The days of the week on which the seller delivers the goods to the warehouse.
Day of the week:

  • MONDAY — Monday.
  • TUESDAY "Tuesday."
  • WEDNESDAY — Wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY "Saturday."
  • SUNDAY — Sunday.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Min items: 1

Unique items  

transportUnitSize

Type: integer<int32>

The number of items in one package that you deliver to the warehouse.

For example, if you supply baby food in boxes of 6 cans, specify the value 6.

urls

Type: string[]

The URL of the product photo or description page on your website.

The transmitted data will not be displayed on the showcase, but it will help the Market specialists find a card for your product.

Must contain one nested parameter. url.

Min length: 1

Max length: 2000

Min items: 1

Unique items  

vendor

Type: string

The name of the brand or manufacturer. It should be written the way the brand itself writes it.

Example: LEVENHUK

vendorCode

Type: string

The article of the product from the manufacturer.

Example: VNDR-0005A

weightDimensions

Type: OfferWeightDimensionsDTO

The dimensions of the package and the weight of the product.

OfferAvailabilityStatusType

Delivery plans:

  • ACTIVE — there will be supplies.
  • INACTIVE — there will be no deliveries: the product is in stock, but you no longer plan to deliver it. 60 days after the product runs out of stock, this status will change to DELISTED.
  • DELISTED — archive: the product has run out of stock, and there will be no more deliveries. If the product is returned to the warehouse (for example, the customer returns the order), this status will change to INACTIVE.

Type

Description

OfferAvailabilityStatusType

Enum: ACTIVE, INACTIVE, DELISTED

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: HOUR, DAY, WEEK, MONTH, YEAR

comment

Type: string

Comment.

Max length: 500

OfferProcessingStateDTO

Information about the publication status of the product on the Market.

Name

Description

notes

Type: OfferProcessingNoteDTO[]

The reasons why the product failed moderation.
The reasons why the product failed moderation.

Min items: 1

status

Type: OfferProcessingStatusType

Product publication status:

  • UNKNOWN — unknown status.
  • READY — the product has passed moderation. To place it on the Market, set a price for it.
  • IN_WORK — the product is undergoing moderation. It takes a few days.
  • NEED_INFO — the product failed moderation due to errors or missing information in the product description. Information about the reasons for the deviation is returned in the parameter notes.
  • NEED_MAPPING — you can't create a card for a product.
  • NEED_CONTENT — for a product without a SKU on the Market (marketSku) you need to find the card yourself (via the API or the seller's account on the Market) or create it if the product is not yet on sale on the Market.
  • CONTENT_PROCESSING — the product is under moderation.
  • SUSPENDED — the product has not passed moderation, as the Market does not yet place such products.
  • REJECTED — the product has not passed moderation, as the Market does not plan to post such products.
  • REVIEW — a decision is being made on the placement of the product.
  • CREATE_ERROR — the product profile could not be created.
  • UPDATE_ERROR — the product card has unused changes.

Enum: UNKNOWN, READY, IN_WORK, NEED_INFO, NEED_MAPPING, NEED_CONTENT, CONTENT_PROCESSING, SUSPENDED, REJECTED, REVIEW, CREATE_ERROR, UPDATE_ERROR

DayOfWeekType

Day of the week:

  • MONDAY — Monday.
  • TUESDAY "Tuesday."
  • WEDNESDAY — Wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY "Saturday."
  • SUNDAY "Sunday."

Type

Description

DayOfWeekType

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

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.

Multi-seat cargo measurement scheme

Name

Description

height*

Type: number

Package height in cm.

Example: 20

Min value: 0

length*

Type: number

Package length in cm.

Example: 65.55

Min value: 0

weight*

Type: number

The weight of the product in kg, including packaging (gross).

Example: 1.001

Min value: 0

width*

Type: number

Package width in cm.

Example: 50.7

Min value: 0

TimeUnitType

Time measurement unit:

  • HOUR "An hour."
  • DAY — a day.
  • WEEK — a week.
  • MONTH — a month.
  • YEAR — a year.

Type

Description

TimeUnitType

Enum: HOUR, DAY, WEEK, MONTH, YEAR

OfferProcessingNoteDTO

The reasons why the product failed moderation.

Name

Description

payload

Type: string

Additional information about the reason for the product rejection.

type

Type: OfferProcessingNoteType

The type of reason why the product failed moderation.

Enum: ASSORTMENT, CANCELLED, CONFLICTING_INFORMATION, OTHER, DEPARTMENT_FROZEN, INCORRECT_INFORMATION, LEGAL_CONFLICT, NEED_CLASSIFICATION_INFORMATION, NEED_INFORMATION, NEED_PICTURES, NEED_VENDOR, NO_CATEGORY, NO_KNOWLEDGE, NO_PARAMETERS_IN_SHOP_TITLE, NO_SIZE_MEASURE, SAMPLE_LINE

OfferProcessingStatusType

Product publication status:

  • UNKNOWN — unknown status.
  • READY — the product has passed moderation. To place it on the Market, set a price for it.
  • IN_WORK — the product is undergoing moderation. It takes a few days.
  • NEED_INFO — the product failed moderation due to errors or missing information in the product description. Information about the reasons for the deviation is returned in the parameter notes.
  • NEED_MAPPING — you can't create a card for a product.
  • NEED_CONTENT — for a product without a SKU on the Market (marketSku) you need to find the card yourself (via the API or the seller's account on the Market) or create it if the product is not yet on sale on the Market.
  • CONTENT_PROCESSING — the product is under moderation.
  • SUSPENDED — the product has not passed moderation, as the Market does not yet place such products.
  • REJECTED — the product has not passed moderation, as the Market does not plan to post such products.
  • REVIEW — a decision is being made on the placement of the product.
  • CREATE_ERROR — the product profile could not be created.
  • UPDATE_ERROR — the product card has unused changes.

Type

Description

OfferProcessingStatusType

Enum: UNKNOWN, READY, IN_WORK, NEED_INFO, NEED_MAPPING, NEED_CONTENT, CONTENT_PROCESSING, SUSPENDED, REJECTED, REVIEW, CREATE_ERROR, UPDATE_ERROR

OfferProcessingNoteType

The type of reason why the product failed moderation:

  • ASSORTMENT — the product is produced in different versions. Each of them should be described as a separate product (parameter offerMappings in the request POST businesses/{businessId}/offer-mappings/update or a line in the catalog if you upload products through the seller's account on the Market).
  • CANCELLED — the product was withdrawn from moderation on your initiative.
  • CONFLICTING_INFORMATION (previously wrongly CONFLICTING) — you provided conflicting information about the product. The parameters that need to be fixed are specified in the parameter payload.
  • OTHER — the product did not pass moderation for another reason. Contact customer support or your manager.
  • DEPARTMENT_FROZEN — the rules for placing products in this category are being processed, so the product cannot pass moderation yet.
  • INCORRECT_INFORMATION — the product information you provided contradicts the description from the manufacturer. The parameters that need to be fixed are specified in the parameter payload.
  • LEGAL_CONFLICT — the product did not pass moderation for legal reasons. For example, it is not officially sold in Russia or you do not have a permit to sell it.
  • NEED_CLASSIFICATION_INFORMATION — the information about the product that you provided is not enough to classify it. Make sure that you have correctly specified the name, category, manufacturer, and country of manufacture of the product, as well as the URLs of images or description pages that can be used to identify the product.
  • NEED_INFORMATION — the product has not been sold in Russia before and is not yet available on the Market. You can create a card for it. For more information, see the section Working with the product card Yandex. Market help for sellers.
  • NEED_PICTURES — to identify a product, you need its images. Send the URL of the product images in the request POST businesses/{businessId}/offer-mappings/update or download the updated catalog through the seller's account on the Market.
  • NEED_VENDOR — the manufacturer of the product is incorrectly specified.
  • NO_CATEGORY, NO_KNOWLEDGE — products from the specified category are not yet placed on the Market. If the category appears, the product will be sent for moderation again.
  • NO_PARAMETERS_IN_SHOP_TITLE — the product is produced in different versions, and it is not clear from the name indicated which one it is about. The parameters to be added to the product name are specified in the parameter payload.
  • NO_SIZE_MEASURE — this product requires a size grid. Send it to the support service or your manager. The size grid requirements are specified in the parameter payload.
  • SAMPLE_LINE — the product did not pass moderation because of an extra line.

Type

Description

OfferProcessingNoteType

Enum: ASSORTMENT, CANCELLED, CONFLICTING_INFORMATION, OTHER, DEPARTMENT_FROZEN, INCORRECT_INFORMATION, LEGAL_CONFLICT, NEED_CLASSIFICATION_INFORMATION, NEED_INFORMATION, NEED_PICTURES, NEED_VENDOR, NO_CATEGORY, NO_KNOWLEDGE, NO_PARAMETERS_IN_SHOP_TITLE, NO_SIZE_MEASURE, SAMPLE_LINE

Responses

200 OK

Information about the products in the catalog.

Body

application/json
{
    "status": "OK",
    "result": {
        "offers": [
            {
                "name": "Ударная дрель Makita HP1630, 710 Вт",
                "shopSku": "string",
                "category": "string",
                "vendor": "LEVENHUK",
                "vendorCode": "VNDR-0005A",
                "description": "string",
                "id": "string",
                "feedId": 0,
                "barcodes": [
                    46012300000000
                ],
                "urls": [
                    "string"
                ],
                "pictures": [
                    "string"
                ],
                "manufacturer": "string",
                "manufacturerCountries": [
                    "string"
                ],
                "minShipment": 0,
                "transportUnitSize": 0,
                "quantumOfSupply": 0,
                "deliveryDurationDays": 0,
                "boxCount": 0,
                "customsCommodityCodes": [
                    "string"
                ],
                "weightDimensions": {
                    "length": 65.55,
                    "width": 50.7,
                    "height": 20,
                    "weight": 1.001
                },
                "supplyScheduleDays": [
                    "MONDAY"
                ],
                "shelfLifeDays": 0,
                "lifeTimeDays": 0,
                "guaranteePeriodDays": 0,
                "processingState": {
                    "status": "UNKNOWN",
                    "notes": [
                        {
                            "type": "ASSORTMENT",
                            "payload": "string"
                        }
                    ]
                },
                "availability": "ACTIVE",
                "shelfLife": {
                    "timePeriod": 0,
                    "timeUnit": "HOUR",
                    "comment": "string"
                },
                "lifeTime": {
                    "timePeriod": 0,
                    "timeUnit": "HOUR",
                    "comment": "string"
                },
                "guaranteePeriod": {
                    "timePeriod": 0,
                    "timeUnit": "HOUR",
                    "comment": "string"
                },
                "certificate": "string",
                "price": 0,
                "marketCategoryId": 0,
                "marketCategoryName": "string",
                "marketModelId": 0,
                "marketModelName": "string",
                "marketSku": 0,
                "marketSkuName": "string"
            }
        ]
    }
}

Name

Description

result

Type: OfferMappingSuggestionsListDTO

A list of recommended product cards.

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

OfferMappingSuggestionsListDTO

A list of recommended product cards.

Name

Description

offers*

Type: EnrichedMappingsOfferDTO[]

The list of products.
Information about recommended product cards.
Information about the products in the catalog.

ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

EnrichedMappingsOfferDTO

Information about recommended product cards.

Name

Description

availability

Type: OfferAvailabilityStatusType

Delivery plans:

  • ACTIVE — there will be supplies.
  • INACTIVE — there will be no deliveries: the product is in stock, but you no longer plan to deliver it. 60 days after the product runs out of stock, this status will change to DELISTED.
  • DELISTED — archive: the product has run out of stock, and there will be no more deliveries. If the product is returned to the warehouse (for example, the customer returns the order), this status will change to INACTIVE.

Enum: ACTIVE, INACTIVE, DELISTED

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: 46012300000000

Min items: 1

Unique items  

boxCount

Type: integer<int32>

How many seats (if more than one) the product occupies.

The parameter is specified only if the product occupies more than one place (for example, the air conditioner occupies two places: an external and an internal unit in two boxes). If the product occupies one place, do not specify this parameter.

category

⦸

Type: string

Instead, use marketCategoryId.

The product category in your store.

certificate

Type: string

The document number for the product.

Before specifying the number, the document must be uploaded to the seller's account on the Market. Instruction manual

customsCommodityCodes

Type: string[]

The list of product codes in the unified Commodity nomenclature of foreign economic activity (HS).

A mandatory parameter if the product is subject to special accounting (for example, in the Mercury system as products of animal origin or in the Honest SIGN system).

It can contain only one nested HS code.

Min items: 1

Unique items  

deliveryDurationDays

Type: integer<int32>

The period for which the seller delivers the goods to the warehouse, in days.

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 HTML tags to format the text:

  • <h>, <h1>, <h2> and so on — for headings;
  • <br> and <p> — for line breaks.
  • <ol> — for a numbered list.
  • <ul> — for a bulleted list.
  • <li> — to create list items (must be inside <ol> or <ul>);
  • <div> is supported, but does not affect the text display.

The optimal length is 400-600 characters.

Recommendations and rules

Max length: 6000

feedId

Type: integer<int64>

The feed ID.

guaranteePeriod

Type: TimePeriodDTO

Information about the warranty period: during which period (in years, months, days, weeks, or hours) maintenance and repair of the product or a refund are possible, and the manufacturer or seller will be responsible for the defects of the product.

A required parameter if the product has a warranty period.

The product has a warranty period, but you won't specify it.

The product will be hidden from the Market.

guaranteePeriodDays

Type: integer<int32>

Product warranty period: how many days is it possible to service and repair the product or refund money, and the manufacturer or seller will be responsible for the defects of the product.

id

Type: string

Your SKU is the product identifier in your system.

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.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

lifeTime

Type: TimePeriodDTO

Service life information: for what period (in years, months, days, weeks, or hours) The product will perform its function properly, and the manufacturer will be responsible for its significant shortcomings.

A required parameter if the product has a service life.

The product has a service life, but you don't specify it.

The product will be hidden from the Market.

lifeTimeDays

⦸

Type: integer<int32>

Instead, use lifeTime. Using both parameters together will result in an error.

Service life: how many days the product will properly perform its function, and the manufacturer will be responsible for its significant shortcomings.

manufacturer

Type: string

Product manufacturer: the company that produced the product, its address and registration number (if any).

Optional parameter.

manufacturerCountries

Type: string[]

A list of countries where the product is manufactured.

Required parameter.

It must contain at least one, but not more than 5 countries.

Min items: 1

Max items: 5

Unique items  

marketCategoryId

Type: integer<int64>

The category ID for the recommended product card on the Market.

It is returned only with the parameter marketSku.

marketCategoryName

Type: string

The name of the category for the recommended product card on the Market.

It may be missing from the response.

marketModelId

⦸

Type: integer<int64>

The model ID for the recommended product card on the Market.

It may be missing from the response.

marketModelName

⦸

Type: string

The name of the model for the recommended product card on the Market.

It is returned only with the parameter marketSku.

marketSku

Type: integer<int64>

SKU on the Market is the identifier of the recommended product card on the Market.

The parameter is returned if a card is found for the product. If the parameter is not in the response, it is possible that the product is not yet on sale on the Market or you have provided incomplete (incorrect) data in the request.

Min value: 1

marketSkuName

Type: string

The product name from the recommended card on the Market.

It may be missing from the response.

minShipment

Type: integer<int32>

The minimum number of items that you deliver to the warehouse.

For example, if you supply baby food in batches of at least 10 boxes, and each box contains 6 jars, specify the value 60.

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.

Recommendations and rules

Example: Impact drill Makita HP1630, 710 W

Max length: 256

pictures

Type: string[]

Links (URLs) of product images in good quality.

You can specify up to 30 links. In this case, the image on the first link will be the main one. It is used as a product image in the Market search and on the product card. Other product images are available in the enlarged image view.

Min length: 1

Max length: 2000

Min items: 1

Max items: 30

Unique items false

price

Type: number

The price of the product.

processingState

Type: OfferProcessingStateDTO

Information about the publication status of the product on the Market.

quantumOfSupply

⦸

Type: integer<int32>

Additional batch: how many items can be added to the minimum quantity minShipment.

For example, if you supply baby food in batches of at least 10 boxes and want to add 2 boxes to the minimum batch, with 6 jars in each box, specify the value 12.

shelfLife

Type: TimePeriodDTO

Expiration date information: after what time (in years, months, days, weeks, or hours) the product will become unusable. For example, categories such as food and medicines have expiration dates.

A required parameter if the product has an expiration date.

The product has an expiration date, but you don't specify it.

The product will be hidden from the Market.

shelfLifeDays

⦸

Type: integer<int32>

Instead, use shelfLife. Using both parameters together will result in an error.

Expiration date: after how many days the product will become unusable.

shopSku

Type: string

Your SKU is the product identifier in your system.

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.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

supplyScheduleDays

Type: DayOfWeekType[]

The days of the week on which the seller delivers the goods to the warehouse.
Day of the week:

  • MONDAY — Monday.
  • TUESDAY "Tuesday."
  • WEDNESDAY — Wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY "Saturday."
  • SUNDAY — Sunday.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Min items: 1

Unique items  

transportUnitSize

Type: integer<int32>

The number of items in one package that you deliver to the warehouse.

For example, if you supply baby food in boxes of 6 cans, specify the value 6.

urls

Type: string[]

The URL of the product photo or description page on your website.

The transmitted data will not be displayed on the showcase, but it will help the Market specialists find a card for your product.

Must contain one nested parameter. url.

Min length: 1

Max length: 2000

Min items: 1

Unique items  

vendor

Type: string

The name of the brand or manufacturer. It should be written the way the brand itself writes it.

Example: LEVENHUK

vendorCode

Type: string

The article of the product from the manufacturer.

Example: VNDR-0005A

weightDimensions

Type: OfferWeightDimensionsDTO

The dimensions of the package and the weight of the product.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.

Previous
The limit on setting the quantum and minimum quantity of goods
Next
Viewing matching cards