Создание партнерских артикулов

Описание

POST /partner/article/create

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

Для генерации партнерского артикула вы можете передать либо маркетный артикул товара, либо ссылку на товар.

Если вы передаете офферный артикул, то по умолчанию по нему будет найден модельный артикул, и партнерский артикул будет создан для модельного артикула. Чтобы создать партнерский артикул на оффер конкретного продавца, задайте параметр preserveOfferArticle = true.

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

Параметр

Тип

Значение

Обязательный

clid

Int64

Ваш идентификатор в партнерской сети.

Передайте идентификатор clid, который соответствует партнерским ссылкам Яндекс Маркета и с которым связан указанный в запросе авторизационный ключ. Идентификатор можно найти в интерфейсе Яндекс Дистрибуции на вкладке Продукты или узнать у персонального менеджера.

В запросе можно передать только один идентификатор.

да

vid

String

Дополнительный идентификатор партнерской ссылки.

С помощью идентификатора vid можно отслеживать данные отдельно по каждой партнерской ссылке Яндекс Маркета или сравнивать статистику по всем ссылкам на разных страницах. Подробнее о vid читайте в разделе Дополнительный идентификатор инструмента VID Справки партнерской сети Яндекс Маркета.

Если идентификатор указан в запросе, партнерская ссылка будет содержать этот vid. По умолчанию возвращаются ссылки без дополнительных идентификаторов.

В запросе можно передать только один дополнительный идентификатор vid.

нет, по умолчанию пустой

preserveOfferArticle

Boolean

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

нет, по умолчанию false

format

Enum

Формат выходных данных:

  • json
  • xml

нет, по умолчанию json

Тело запроса

Параметр

Тип

Значение

Обязательный

marketArticle

String

Маркетный артикул товара

обязательный, если не задан marketUrl

marketUrl

String

Ссылка на товар. Поддерживаются следующие форматы ссылки:

  • ссылка на карточку модели вида https://market.yandex.ru/product--xxxx/?sku=&uniqueId=&do-waremd5=;

  • ссылка с артикулом вида https://market.yandex.ru/pr/.

обязательный, если не задан marketArticle

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

XML

<result status="{enum}">
  <context id="{string}" time="{date}" marketUrl="{string}">
    <region id="{int32}" name="{string}" type="{enum}" childCount="{int32}">
      <country id="{int32}" name="{string}" type="{enum}" childCount="{int32}"/>
    </region>
    <currency id="{enum}" name="{string}"/>
  </context>
  <partnerArticle partnerArticle="{string}" marketArticle="{string}" clid="{int64}" vid="{string}"/>
</result>

Описание параметров, вложенных в partnerArticle:

Параметр

Тип

Описание

partnerArticle

String

Сгенерированный партнерский артикул.

Пример: "YM10001000"

marketArticle

String

Маркетный артикул товара, для которого сгенерирован партнерский артикул.

Может отличаться от входного значения в случае, если передан офферный артикул и не задан параметр preserveOfferArticle = true.

clid

Int64

Параметр clid, для которого сгенерирован партнерский артикулю

vid

String

Параметр vid, для которого сгенерирован партнерский артикул

Ошибки

В случае ошибки сервер возвращает 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 = '***'

Ссылка нужного формата, но соответствующий маркетный артикул не найден на Яндекс Маркете

preserveOfferArticle = 'true' but market article '***' is not an offer article (offer article first digit is in range 3-9)

На вход передан модельный или артикул sku-формата, совместно с опцией preserveOfferArticle

preserveOfferArticle = 'true' but market article '***' is not an offer article (offer article first digit is in range 3-9). Market article '***' was resolved from url '***'. This can happen if offer was not found for url

На вход передана ссылка, из которой получили модельный или артикул sku-формата, совместно с опцией preserveOfferArticle

Примеры

Запрос:

curl -X POST -i \
-H 'Authorization: <ключ>' \
-H 'Content-Type: application/json' \
-d '{"marketArticle":"5981387253"}' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/partner/article/create'\
'?clid=2310490'\
'&format=json'

Ответ:

HTTP/1.1 200 OK
Date: Mon, 17 Feb 2025 14:51:35 GMT
Content-Type: application/json;charset=utf-8
...
{
    "status": "OK",
    "context": {
        "region": {
            "id": 225,
            "name": "Россия",
            "country": {
                "id": 225,
                "name": "Россия",
                "type": "COUNTRY",
                "childCount": 11
            },
            "type": "COUNTRY",
            "childCount": 11,
            "coordinates": {
                "latitude": 61.698653,
                "longitude": 99.505405
            }
        },
        "currency": {
            "id": "RUR",
            "name": "руб."
        },
        "id": "1739793094475/3fa45c876e305adce9fe6025552e0600/1",
        "time": "2025-02-17T14:51:35.041+03:00",
        "marketUrl": "https://market.yandex.ru?pp=1001&clid=2310490&mclid=1003&distr_type=7"
    },
    "partnerArticle": {
        "partnerArticle": "YM1000123",
        "marketArticle": "1297695178",
        "clid": 2310490,
        "vid": ""
    }
}

Запрос:

curl -X POST -i \
-H 'Authorization: <ключ>' \
-H 'Content-Type: application/json' \
-d '{"marketUrl":"https://market.yandex.ru/pr/5981387253"}' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/partner/article/create'\
'?clid=2310490'\
'&vid=myVid111'\
'&preserveOfferArticle=true'\
'&format=json'

Ответ:

HTTP/1.1 200 OK
Date: Mon, 17 Feb 2025 14:51:35 GMT
Content-Type: application/json;charset=utf-8
...
{
    "status": "OK",
    "context": {
        "region": {
            "id": 225,
            "name": "Россия",
            "country": {
                "id": 225,
                "name": "Россия",
                "type": "COUNTRY",
                "childCount": 11
            },
            "type": "COUNTRY",
            "childCount": 11,
            "coordinates": {
                "latitude": 61.698653,
                "longitude": 99.505405
            }
        },
        "currency": {
            "id": "RUR",
            "name": "руб."
        },
        "id": "1739793094475/3fa45c876e305adce9fe6025552e0600/1",
        "time": "2025-02-17T14:51:35.041+03:00",
        "marketUrl": "https://market.yandex.ru?pp=1001&clid=2310490&mclid=1003&distr_type=7"
    },
    "partnerArticle": {
        "partnerArticle": "YM1000124",
        "marketArticle": "5981387253",
        "clid": 2310490,
        "vid": "myVid111"
    }
}
Предыдущая
Создание партнерских ссылок Маркета
Следующая
Отчет по нескольким заказам