Отчет по нескольким заказам
Описание
GET /orders
Возвращает список заказов, совершенных на Маркете, которые покупатели оформили после взаимодействия с вашими инструментам монетизации: например, после кликов по партнерским ссылкам.
Чтобы получить отчет по одному заказу используйте запрос GET /order.
При желании вы также можете получить отчет по нескольким заказам в личном кабинете Яндекс.Дистрибуции. Подробнее см. в Справке партнерской сети.
URL ресурса:
https://api.content.market.yandex.ru/v3/affiliate/orders
Входные данные
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
clid | Int64 | Ваш идентификатор в партнерской сети. Передайте идентификатор CLID, с которым связан указанный в запросе авторизационный ключ. Идентификатор можно найти в интерфейсе Яндекс.Дистрибуции, на странице Продукты, или узнать у персонального менеджера. |
Необязательные | ||
format | Enum | Формат выходных данных:
Значение по умолчанию: json. |
dateStart | Datetime | Начальная дата и время для фильтрации заказов по дате создания. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время регистрации партнера. |
dateEnd | Datetime | Конечная дата и время для фильтрации заказов по дате создания. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время выполнения запроса. |
updateStart | Datetime | Начальная дата и время для фильтрации заказов по дате изменения статуса. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время регистрации партнера. |
updateEnd | Datetime | Конечная дата и время для фильтрации заказов по дате изменения статуса. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время выполнения запроса. |
vid | String | Дополнительный идентификатор инструмента монетизации для фильтрации заказов. С помощью идентификатора VID можно отслеживать данные отдельно по одному инструменту монетизации (например, виджету или партнерской ссылке) или сравнивать статистику по одинаковым инструментам на разных страницах. Подробнее см. в разделе Дополнительный идентификатор инструмента VID. Если идентификатор указан в запросе, возвращаются заказы, оформленные покупателями после взаимодействия с инструментом монетизации с этим идентификатором. По умолчанию возвращаются все заказы. |
status | Enum | Статус заказов для фильтрации:
По умолчанию возвращаются заказы с любым статусом. |
total | Boolean | Возвращать ли обобщенную информацию о заказах, без списка товаров:
Значение по умолчанию: false. |
page | Int64 | Номер страницы результатов. Значение по умолчанию: 1. |
count | Int16 | Количество результатов на странице: от 1 до 1000. Значение по умолчанию: 10. |
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
clid | Int64 | Ваш идентификатор в партнерской сети. Передайте идентификатор CLID, с которым связан указанный в запросе авторизационный ключ. Идентификатор можно найти в интерфейсе Яндекс.Дистрибуции, на странице Продукты, или узнать у персонального менеджера. |
Необязательные | ||
format | Enum | Формат выходных данных:
Значение по умолчанию: json. |
dateStart | Datetime | Начальная дата и время для фильтрации заказов по дате создания. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время регистрации партнера. |
dateEnd | Datetime | Конечная дата и время для фильтрации заказов по дате создания. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время выполнения запроса. |
updateStart | Datetime | Начальная дата и время для фильтрации заказов по дате изменения статуса. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время регистрации партнера. |
updateEnd | Datetime | Конечная дата и время для фильтрации заказов по дате изменения статуса. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время выполнения запроса. |
vid | String | Дополнительный идентификатор инструмента монетизации для фильтрации заказов. С помощью идентификатора VID можно отслеживать данные отдельно по одному инструменту монетизации (например, виджету или партнерской ссылке) или сравнивать статистику по одинаковым инструментам на разных страницах. Подробнее см. в разделе Дополнительный идентификатор инструмента VID. Если идентификатор указан в запросе, возвращаются заказы, оформленные покупателями после взаимодействия с инструментом монетизации с этим идентификатором. По умолчанию возвращаются все заказы. |
status | Enum | Статус заказов для фильтрации:
По умолчанию возвращаются заказы с любым статусом. |
total | Boolean | Возвращать ли обобщенную информацию о заказах, без списка товаров:
Значение по умолчанию: false. |
page | Int64 | Номер страницы результатов. Значение по умолчанию: 1. |
count | Int16 | Количество результатов на странице: от 1 до 1000. Значение по умолчанию: 10. |
Выходные данные
Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.
{
"status": "{enum}",
"orders":
[
{
"clid": {int64},
"vid": "{string}",
"promoсode": "{string}",
"orderId": {int64},
"dateCreated": "{datetime}",
"dateUpdated": "{datetime}",
"status": "{enum}",
"additionalInfo":
[
"{enum}",
...
],
"cart": {bigdecimal},
"payment": {bigdecimal},
"tariff": "{enum}",
"items":
[
{
"itemId": {int32},
"itemCount": {int16},
"cart": {bigdecimal},
"payment": {bigdecimal},
"tariffName": "{enum}",
"tariffRate": {bigdecimal}
},
...
]
},
]
}
<result status="{enum}">
<orders>
<order>
<clid>{int64}</clid>
<vid>{string}</vid>
<promoсode>{string}</promoсode>
<orderId>{int64}</orderId>
<dateCreated>{datetime}</dateCreated>
<dateUpdated>{datetime}</dateUpdated>
<status>{enum}</status>
<additionalInfo>
<info>{enum}</info>
...
</additionalInfo>
<cart>{bigdecimal}</cart>
<payment>{bigdecimal}</payment>
<tariff>{enum}</tariff>
<items>
<item>
<itemId>{int32}</itemId>
<itemCount>{int16}</itemCount>
<cart>{bigdecimal}</cart>
<payment>{bigdecimal}</payment>
<tariffName>{enum}</tariffName>
<tariffRate>{bigdecimal}</tariffRate>
</item>
...
</items>
</order>
</orders>
</result>
Описание параметров:
Параметр для формата JSON | Параметр для формата XML | Тип | Описание |
---|---|---|---|
result | Ответ. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в result | |||
status | status | Enum | Статус выполнения запроса:
Для формата XML является атрибутом параметра result. |
orders | orders | Список заказов. | |
Параметры, вложенные в orders | |||
order | Информация о заказе. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в orders / order | |||
clid | clid | Int64 | Ваш идентификатор в партнерской сети. |
vid | vid | String | Дополнительный идентификатор инструмента монетизации, с которым покупатель взаимодействовал перед оформлением заказа на Маркете. |
promoсode | promoсode | String | Партнерский промокод, который покупатель указал в заказе. |
orderId | orderId | Int64 | Номер заказа. |
dateCreated | dateCreated | Datetime | Дата и время создания заказа. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). |
dateUpdated | dateUpdated | Datetime | Дата и время последнего изменения статуса заказа. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). |
status | status | Enum | Статус заказа:
|
additionalInfo | additionalInfo | Список причин, по которым вознаграждение за заказ не выплачивается. Возвращается, только если параметр status имеет значение CANCELLED. | |
cart | cart | BigDecimal | Сумма заказа в рублях. |
payment | payment | BigDecimal | Сумма вознаграждения за заказ в рублях. |
tariff | tariff | Enum | Тариф, по которому выплачивается вознаграждение за заказ:
Подробнее о расчете вознаграждений см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. |
items | items | Список товаров в заказе. Возвращается, только если входной параметр total не указан или в нем указано значение false. | |
Параметры, вложенные в additionalInfo | |||
info | Код причины, по которой вознаграждение за заказ не выплачивается:
Подробнее см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. Возвращается, только если параметр status имеет значение CANCELLED. Параметр возвращается только для формата XML. Для формата JSON возвращается код в виде строки. | ||
Параметры, вложенные в items | |||
item | Информация о товаре. Возвращается, только если входной параметр total не указан или в нем указано значение false. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в items / item | |||
itemId | itemId | Int32 | Номер товара в заказе. Нумерация начинается с 0. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
itemCount | itemCount | Int16 | Количество единиц товара в заказе, за которые должно быть выплачено вознаграждение. За товары, которые покупатель начал возвращать в течение двух недель со дня получения, вознаграждение не выплачивается. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
cart | cart | BigDecimal | Общая стоимость всех единиц товара в заказе. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
payment | payment | BigDecimal | Общее вознаграждение за все единицы товара в заказе. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
tariffName | tariffName | Enum | Код тарифной категории, к которой относится товар:
Подробнее см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
tariffRate | tariffRate | BigDecimal | Доля от общей стоимости всех единиц товара в заказе, выплачиваемая как вознаграждение. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
Параметр для формата JSON | Параметр для формата XML | Тип | Описание |
---|---|---|---|
result | Ответ. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в result | |||
status | status | Enum | Статус выполнения запроса:
Для формата XML является атрибутом параметра result. |
orders | orders | Список заказов. | |
Параметры, вложенные в orders | |||
order | Информация о заказе. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в orders / order | |||
clid | clid | Int64 | Ваш идентификатор в партнерской сети. |
vid | vid | String | Дополнительный идентификатор инструмента монетизации, с которым покупатель взаимодействовал перед оформлением заказа на Маркете. |
promoсode | promoсode | String | Партнерский промокод, который покупатель указал в заказе. |
orderId | orderId | Int64 | Номер заказа. |
dateCreated | dateCreated | Datetime | Дата и время создания заказа. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). |
dateUpdated | dateUpdated | Datetime | Дата и время последнего изменения статуса заказа. Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва). |
status | status | Enum | Статус заказа:
|
additionalInfo | additionalInfo | Список причин, по которым вознаграждение за заказ не выплачивается. Возвращается, только если параметр status имеет значение CANCELLED. | |
cart | cart | BigDecimal | Сумма заказа в рублях. |
payment | payment | BigDecimal | Сумма вознаграждения за заказ в рублях. |
tariff | tariff | Enum | Тариф, по которому выплачивается вознаграждение за заказ:
Подробнее о расчете вознаграждений см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. |
items | items | Список товаров в заказе. Возвращается, только если входной параметр total не указан или в нем указано значение false. | |
Параметры, вложенные в additionalInfo | |||
info | Код причины, по которой вознаграждение за заказ не выплачивается:
Подробнее см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. Возвращается, только если параметр status имеет значение CANCELLED. Параметр возвращается только для формата XML. Для формата JSON возвращается код в виде строки. | ||
Параметры, вложенные в items | |||
item | Информация о товаре. Возвращается, только если входной параметр total не указан или в нем указано значение false. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в items / item | |||
itemId | itemId | Int32 | Номер товара в заказе. Нумерация начинается с 0. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
itemCount | itemCount | Int16 | Количество единиц товара в заказе, за которые должно быть выплачено вознаграждение. За товары, которые покупатель начал возвращать в течение двух недель со дня получения, вознаграждение не выплачивается. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
cart | cart | BigDecimal | Общая стоимость всех единиц товара в заказе. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
payment | payment | BigDecimal | Общее вознаграждение за все единицы товара в заказе. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
tariffName | tariffName | Enum | Код тарифной категории, к которой относится товар:
Подробнее см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
tariffRate | tariffRate | BigDecimal | Доля от общей стоимости всех единиц товара в заказе, выплачиваемая как вознаграждение. Возвращается, только если входной параметр total не указан или в нем указано значение false. |
Ошибки
В случае ошибки сервер возвращает HTTP‑код ответа и краткое описание ошибки.
Примеры
Запрос:
curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/orders'\
'?clid=2310490'\
'&status=APPROVED'\
'&format=json'
Ответ:
HTTP/1.1 200 OK
Date: Fri, 17 Jul 2020 07:17:08 GMT
Content-Type: application/json;charset=utf-8
...
{
"status": "OK",
"orders":
[
{
"clid": 2310490,
"vid": "764",
"promocode": "PROMOCODE-AF",
"orderId": 13659638,
"dateCreated": "2020-06-30T15:18:34",
"dateUpdated": "2020-07-15T11:42:35",
"status": "APPROVED",
"cart": 1117.00,
"payment": 94.41,
"tariff": "general",
"items":
[
{
"itemId": 0,
"itemCount": 1,
"cart": 563.00,
"payment": 49.54,
"tariffName": "FASHION",
"tariffRate": 0.088
},
{
"itemId": 1,
"itemCount": 2,
"cart": 554.00,
"payment": 44.87,
"tariffName": "KIDS",
"tariffRate": 0.081
}
]
},
{
"clid": 2310490,
"vid": "533",
"orderId": 13548230,
"dateCreated": "2020-06-27T18:32:43",
"dateUpdated": "2020-07-13T13:07:10",
"status": "APPROVED",
"cart": 200.00,
"payment": 14.00,
"tariff": "general",
"items":
[
{
"itemId": 0,
"itemCount": 2,
"cart": 200.00,
"payment": 14.00,
"tariffName": "DIY",
"tariffRate": 0.07
}
]
}
]
}
Запрос:
curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/orders'\
'?clid=2310490'\
'&status=APPROVED'\
'&format=xml'
Ответ:
HTTP/1.1 200 OK
Date: Fri, 17 Jul 2020 07:17:08 GMT
Content-Type: application/xml;charset=utf-8
...
<result status="OK">
<orders>
<order>
<clid>2310490</clid>
<vid>764</vid>
<promocode>PROMOCODE-AF</promocode>
<orderId>13659638</orderId>
<dateCreated>2020-06-30T15:18:34</dateCreated>
<dateUpdated>2020-07-15T11:42:35</dateUpdated>
<status>APPROVED</status>
<cart>1117.00</cart>
<payment>94.41</payment>
<tariff>general</tariff>
<items>
<item>
<itemId>0</itemId>
<itemCount>1</itemCount>
<cart>563.00</cart>
<payment>49.54</payment>
<tariffName>FASHION</tariffName>
<tariffRate>0.088</tariffRate>
</item>
<item>
<itemId>1</itemId>
<itemCount>2</itemCount>
<cart>554.00</cart>
<payment>44.87</payment>
<tariffName>KIDS</tariffName>
<tariffRate>0.081</tariffRate>
</item>
</items>
</order>
<order>
<clid>2310490</clid>
<vid>533</vid>
<orderId>13548230</orderId>
<dateCreated>2020-06-27T18:32:43</dateCreated>
<dateUpdated>2020-07-13T13:07:10</dateUpdated>
<status>APPROVED</status>
<cart>200.00</cart>
<payment>14.00</payment>
<tariff>general</tariff>
<items>
<item>
<itemId>0</itemId>
<itemCount>2</itemCount>
<cart>200.00</cart>
<payment>14.00</payment>
<tariffName>DIY</tariffName>
<tariffRate>0.07</tariffRate>
</item>
</items>
</order>
</orders>
</result>