Создание реферальных артикулов

Описание

POST /partner/article/create

Создает реферальный артикул для переданных параметров. В том случае, если такой артикул уже существует, возвращает его.
Для генерации реферального артикула вы можете передать либо маркетный артикул товара, либо ссылку на товар.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/partner/article/create

Входные данные

Параметр	Тип	Значение	Обязательный
`place_id`	Int64	Идентификатор площадки, для которой создаётся реферальный артикул. Его можно найти в личном кабинете Реферальной программы на Яндекс Маркете в разделе «Блоги».	да
`clid`	Int64	Ваш идентификатор в реферальной программе. Передайте идентификатор CLID типа «Артикулы Маркета» для площадки, для которой хотите создать реферальный артикул. Может быть указан вместо `place_id`.	нет
`vid`	String	Дополнительный идентификатор реферальной ссылки. С помощью идентификатора `vid` можно отслеживать данные отдельно по каждой реферальной ссылке Яндекс Маркета или сравнивать статистику по всем ссылкам на разных страницах. Подробнее о `vid` читайте в разделе Дополнительный идентификатор инструмента VID Справки реферальной программы Яндекс Маркета. Если идентификатор указан в запросе, реферальная ссылка будет содержать этот `vid`. По умолчанию возвращаются ссылки без дополнительных идентификаторов. В запросе можно передать только один дополнительный идентификатор `vid`.	нет, по умолчанию пустой
`format`	Enum	Формат выходных данных: `json` `xml`	нет, по умолчанию `json`

Тело запроса

Параметр	Тип	Значение	Обязательный
`marketArticle`	String	Маркетный артикул товара	обязательный, если не задан `marketUrl`
`marketUrl`	String	Ссылка на товар вида https://market.yandex.ru/card/...	обязательный, если не задан `marketArticle`

Выходные данные

{
  "status": "{enum}",
   "partnerArticle":
      {
        "partnerArticle": "{string}",
        "marketArticle": "{string}",
        "clid": "{int64}",
        "vid": "{string}",
        "productPhoto": "{string}",
        "title": "{string}"
      },
  "link": "{string}",
  "promise": "{int64}",
  "price": "{int64}",
  "rewardInUrl": "{int64}"
 
}

Описание параметров:

Параметр	Тип	Описание
`status`	Enum	Статус выполнения запроса: `OK` — запрос выполнен успешно. `ERROR` — произошла ошибка.
`link`	String	Ссылка. При создание реферального артикула возвращает NULL.
`promise`	Int64	Вознаграждение, закрепленное за ссылкой.
`price`	Int64	Зеленая цена товара.
`rewardInUrl`	Int64	Вознаграждение, закреплённое за ссылкой в момент её создания.
Параметры, вложенные в `partnerArticle`
`partnerArticle`	String	Сгенерированный реферальный артикул. Пример: `"YM10001000"`
`marketArticle`	String	Маркетный артикул товара, для которого сгенерирован реферальный артикул.
`clid`	Int64	Параметр `clid`, для которого сгенерирован реферальный артикул.
`vid`	String	Параметр `vid`, для которого сгенерирован реферальный артикул.
`productPhoto`	String	Ссылка на изображение товара.
`title`	String	Название товара.

Ошибки

В случае ошибки сервер возвращает HTTP‑код ответа и краткое описание ошибки.

Возможные ошибки:

Текст ошибки	Пояснение
Client clid does not match	Передан несуществующий или чужой параметр `clid`
Parameter 'vid' format is incorrect. Incorrect value '`***`'. VID must be up to 150 characters long and contain only latin letters and numbers	Передан недопустимый параметр `vid`
Invalid market article '`***`'	Переданный маркетный артикул не найден на Яндекс Маркете
Input URL '`*`' doesn't lead to market	На вход передана ссылка с URL, отличным от `market.yandex.ru`
Unsupported input URL format: ***	На вход передана ссылка на Яндекс Маркет, но формат этой ссылки не поддерживается
Can't find market article for productId = '`*`' and skuId = '``' and offerId = '`**`'	Ссылка нужного формата, но соответствующий маркетный артикул не найден на Яндекс Маркете

Примеры

Запрос:

curl -X POST -i \
-H 'Authorization: OAuth <token>' \
-H 'Content-Type: application/json' \
-d '{"marketArticle":"5828126315"}' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/partner/article/create'\
'?clid=15085330'\
'&format=json'

Ответ:

{
  "status": "OK",
  "partnerArticle": {
      "partnerArticle": "YM10469939",
      "marketArticle": "5828126315",
      "clid": 15085330,
      "vid": "",
      "productPhoto": "https://avatars.mds.yandex.net/get-mpic/17406069/2a0000019eb8ed516c48c5be4433698a798f/300x300",
      "title": "Беспроводные наушники COMMO Etude с функцией адаптивного шумоподавления ANC, лавандовый"
  },
  "link": null,
  "promise": 658,
  "price": 8072,
  "rewardInUrl": null
}

Была ли статья полезна?

Создание реферальных ссылок Маркета

Отчет по нескольким заказам