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

Описание

GET /partner/link/create

Возвращает реферальную ссылку. Она содержит переданный вами URL страницы Яндекс Маркета и необходимые дополнительные GET‑параметры. Такую ссылку вы можете разместить на своей площадке, чтобы получать вознаграждение за заказы на Яндекс Маркете.

URL ресурса:

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

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

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

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

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

{
  "status": "{enum}",
  "partnerArticle": "{string}",
   "link":
      {
        "url": "{string}",
        "shortUrl": "{string}",
        "searchType": "{enum}",
        "pageName": "{string}",
        "productPhoto": "{string}",
        "title": "{string}"
      },
  "promise": "{int64}",
  "price": "{int64}",
  "rewardInUrl": "{int64}"
 
}

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

Параметр	Тип	Описание
`status`	Enum	Статус выполнения запроса: `OK` — запрос выполнен успешно. `ERROR` — произошла ошибка.
`partnerArticle`	String	Реферальный артикул. При создание реферальной ссылки возвращает NULL.
`link`	Object	Информация о созданной реферальной ссылке.
`promise`	Int64	Вознаграждение, закрепленное за ссылкой.
`price`	Int64	Зеленая цена товара.
`rewardInUrl`	Int64	Вознаграждение, закреплённое за ссылкой в момент её создания.
Параметры, вложенные в `link`
`url`	String	Реферальная ссылка. В конце ссылки добавляется идентификатор рекламы `erid`, если он был передан.
`shortUrl`	String	Короткая реферальная ссылка. Ведёт на ту же страницу и внутри себя содержит такие же дополнительные параметры, что и ссылка в `url`. В конце ссылки добавляется идентификатор рекламы `erid`, если он был передан. Используйте короткую ссылку, если не хотите оборачивать ее в текст. Так реферальная ссылка займет намного меньше места.
`searchType`	Enum	Тип, по умолчанию возвращает `LINK`.
`pageName`	String	Тип страницы Яндекс Маркета, на которую ведет реферальная ссылка: `POKUPKI_PRODUCT` — карточка товара на Яндекс Маркете; `MARKET_CART` — корзина на Яндекс Маркете; `MARKET_WISHLIST` — список товаров на Яндекс Маркете.
`productPhoto`	String	Ссылка на изображение товара, если был передан URL конкретного товара.
`title`	String	Название товара.

Ошибки

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

Примеры

Запрос:

curl -i \
-H 'Authorization: OAuth <token>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/partner/link/create'\
'?url=https://market.yandex.ru/cc/9rsgau'\
'&clid=15085330'\
'&format=json'

Ответ:

{
    "status": "OK",
    "partnerArticle": null,
    "link": {
        "url": "https://market.yandex.ru/card/besprovodnyye-naushniki-commo-etude-s-funktsiyey-aktivnogo-shumopodavleniya-anc-lavandovyy/5828126315?offerid=LAXBheAk3EIfugf1_X3cyg&hid=90555&nid=26992150&cpc=sGhE48lBX3rKmvP1Bj1aS1QdBL55fP_tmxnY_88-t5kBIMUKNH-pA8H1ETAnJnzluIvVXuTYPEdQuHHLwPiN139uIP3GHJS6ZKLeUffvZij-epDNKrRWRnRLDdksvmcdE3rVtI3pHe4pAB0nB_JuwiA-ysfaguzwy2ElorhZkJ9InOqtHsObSrlAVIRuTyj2N5GUPQvdZR3Gc-gWV-7G6ZbRCxvx6ulN7F37YRNcE06_dAKEFhUhVyW5WLZVqfvkd-ugJ4ZslGjHsCozIBH29d3HSsodosSklynkDYdaMzr9xUO9J6WlWUUs2f3LJC2txEdEePsbwOGGRkcQqjtnDL8WufpxALeR592RQxs5SgV7mgC5WgMnIr4otWLByNW7fD9Lm_ju1gkIZPX3mJsWAeRRw8xa_tZC5JZximJbqueuQpiWa31WsDDV7r3uC3Pd&businessId=83022309&publicId=n6ca6cxyuvqe1kgegkvzkh2vtw&utm_referral_context=O1ArE3aHcXvCdLWdOSYpTkx-U82q3_hPtVEqxXKXNmCEKB7yqKkLejFA1iFb_Efo1fVpgJN6B0PYyqXut_qTmc0YI1Rdj0wZ7m1j5T37t8xGjzVzqwKhBhR5sL1Bv3Jdj2m4-3ItHyvyF17o6EE1ruMvTb6baVnt0_ND-h0RTOVqhAa9kmVMkwnF9CWBw9KhQsCOnTcusiA,&cpa=1&utm_medium=link&isComfortPlus=false&refid=06jerlzguo9uleutzefez3ds04fah7uz&do-waremd5=LAXBheAk3EIfugf1_X3cyg&clid=15085330&mclid=1003&distr_type=7&utm_source=partner_network&pp=900&utm_campaign=15085330",
        "shortUrl": "https://market.yandex.ru/cc/9rsgpy",
        "searchType": "LINK",
        "pageName": "POKUPKI_PRODUCT",
        "productPhoto": "https://avatars.mds.yandex.net/get-mpic/17406069/2a0000019eb8ed516c48c5be4433698a798f/300x300",
        "title": "Беспроводные наушники COMMO Etude с функцией адаптивного шумоподавления ANC, лавандовый"
    },
    "promise": 658,
    "price": 8072,
    "rewardInUrl": null
}

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

Справочник запросов

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