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 specified in URL product cards, after «...sku=» for example:

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

To get the recommended ones for the products SKU on the Market, send it in the body POST-Request as much information about them as possible: names, manufacturers, barcodes, prices, etc.

Received SKU You can send it along with information about your products using a request. POST v2/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/v2/campaigns/{campaignId}/offer-mapping-entries/suggestions

Path parameters

Name

Description

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

  • block Campaign ID;
  • tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

  • the store's identifier, which is displayed in the merchant's personal account.
  • advertising campaigns.

Min value: 1

Body

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

Name

Description

offers

Type: object[]

The list of products.

Min items: 1

Max items: 500

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

Responses

200 OK

Information about the products in the catalog.

Body

application/json
{
  "status": "OK",
  "result": {
    "offers": [
      {}
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    The type of response. Possible values:

    • OK — There are no errors.
    • ERROR — an error occurred while processing the request.

    Enum: OK, ERROR

    The standard wrapper for server responses.

    Example
    {
  "status": "OK"
}
  • Type: object

    result
    Type: object

    offers

    Type: object[]

    The list of products.

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

    A list of recommended product cards.

    Example
    {
  "offers": [
    {
      "name": "Ударная дрель Makita HP1630, 710 Вт",
      "shopSku": "example",
      "category": "example",
      "vendor": "LEVENHUK",
      "vendorCode": "VNDR-0005A",
      "description": "example",
      "id": "example",
      "feedId": 0,
      "barcodes": [
        null
      ],
      "urls": [
        null
      ],
      "pictures": [
        null
      ],
      "manufacturer": "example",
      "manufacturerCountries": [
        null
      ],
      "minShipment": 0,
      "transportUnitSize": 0,
      "quantumOfSupply": 0,
      "deliveryDurationDays": 0,
      "boxCount": 0,
      "customsCommodityCodes": [
        null
      ],
      "weightDimensions": {},
      "supplyScheduleDays": [
        null
      ],
      "shelfLifeDays": 0,
      "lifeTimeDays": 0,
      "guaranteePeriodDays": 0,
      "processingState": {},
      "availability": "ACTIVE",
      "shelfLife": {},
      "lifeTime": {},
      "guaranteePeriod": {},
      "certificate": "example",
      "price": 0.5,
      "marketCategoryId": 0,
      "marketCategoryName": "example",
      "marketModelName": "example",
      "marketSku": 1,
      "marketSkuName": "example"
    }
  ]
}
    Example
    {
  "result": {
    "offers": [
      {
        "marketCategoryId": 0,
        "marketCategoryName": "example",
        "marketModelName": "example",
        "marketSku": 1,
        "marketSkuName": "example"
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

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

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

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

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

No longer supported, please use an alternative and newer version.

What is GTIN?
GTIN — This 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