--- metadata: - name: generator content: Diplodoc Platform v5.66.1 alternate: - https://yandex.com/support/market-distr/ru/api/reference/get-orders.md - href: https://yandex.com/support/market-distr/ru/api/reference/get-orders.md type: text/markdown title: Markdown version - href: https://yandex.com/support/market-distr/ru/llms.txt?revision=r22075821 rel: describedby keywords: GET /orders --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/market-distr/ru/llms.txt?revision=r22075821 # Отчет по нескольким заказам ## Описание {#description} ```no-highlight GET /orders ``` Возвращает список заказов, совершенных на Маркете, которые покупатели оформили после взаимодействия с вашими инструментами монетизации: например, после кликов по реферальным ссылкам. Чтобы получить отчет по одному заказу используйте запрос [GET /order](https://yandex.com/support/market-distr/ru/api/reference/get-order.md). При желании вы также можете получить отчет по нескольким заказам в личном кабинете Яндекс Маркета или Яндекс Дистрибуции. URL ресурса: ```no-highlight https://api.content.market.yandex.ru/v3/affiliate/orders ``` ## Входные данные {#input} #| || **Параметр** | **Тип** | **Значение** || || **Обязательные** | > | > || || `clid` | Int64 | Ваш идентификатор в реферальной программе. Передайте идентификатор CLID, по которому вы хотите получить данные о заказах. || || **Необязательные** | > | > || || `url` | String | Ваша реферальная ссылка, по которой вы хотите посмотреть статистику. || || `partner_article` | String | Ваш реферальный артикул, по которому вы хотите посмотреть статистику. || || `format` | Enum | Формат выходных данных: - `json` - `xml` Значение по умолчанию: `json`. || || `dateStart` | Datetime | Начальная дата и время для фильтрации заказов по дате создания. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время регистрации партнера. || || `dateEnd` | Datetime | Конечная дата и время для фильтрации заказов по дате создания. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время выполнения запроса. || || `updateStart` | Datetime | Начальная дата и время для фильтрации заказов по дате изменения статуса. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время регистрации партнера. || || `updateEnd` | Datetime | Конечная дата и время для фильтрации заказов по дате изменения статуса. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). Значение по умолчанию: дата и время выполнения запроса. || || `status` | Enum | Статус заказов для фильтрации: - `NEW` — в обработке: покупатель оформил заказ, но пока не получил его. - `ON_HOLD` — ждет подтверждения: покупатель получил заказ, но со дня получения не прошло 14 дней. - `APPROVED` — подтвержден: прошло две недели со дня получения заказа. - `CANCELLED` — вознаграждение за заказ не выплачивается. Возможные причины см. в разделе [Вознаграждение за заказы на Маркете](https://yandex.ru/support/market-distr/ru/terms) Справки реферальной программы. По умолчанию возвращаются заказы с любым статусом. || || `total` | Boolean | Возвращать ли обобщенную информацию о заказах, без списка товаров: - `true` — да. - `false` — нет. Значение по умолчанию: `false`. || || `page` | Int64 | Номер страницы результатов. Значение по умолчанию: `1`. || || `count` | Int16 | Количество результатов на странице: от `1` до `1000`. Значение по умолчанию: `10`. || |# ## Выходные данные {#output} Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется. {% list tabs %} - JSON ```json { "status": "{enum}", "orders": [ { "clid": {int64}, "vid": "{string}", "promocode": "{string}", "orderId": {int64}, "dateCreated": "{datetime}", "dateUpdated": "{datetime}", "[status](*status)": "{enum}", "additionalInfo": [ "{[enum](*enum)}", ... ], "cart": {bigdecimal}, "payment": {bigdecimal}, "tariff": "{enum}", "items": [ { "itemId": {int32}, "itemCount": {int16}, "[cart](*cart)": {bigdecimal}, "payment": {bigdecimal}, "tariffName": "{enum}", "tariffRate": {bigdecimal}, "osku":{int64} }, ... ] }, ] } ``` - XML ```xml <[result](*result) status="{enum}"> <[orders](*orders)> <[order](*order)> <[clid](*clid)>{int64} <[vid](*vid)>{string} <[promocode](*promo-order)>{string} <[orderId](*order-id)>{int64} <[dateCreated](*date-created)>{datetime} <[dateUpdated](*date-updated)>{datetime} <[status](*status)>{enum} <[additionalInfo](*additional-info)> <[info](*enum)>{enum} ... <[cart](*cart-orders)>{bigdecimal} <[payment](*payment)>{bigdecimal} <[tariff](*tariff)>{enum} <[items](*items-orders)> <[item](*item-orders)> <[itemId](*item-id-orders)>{int32} <[itemCount](*item-count-orders)>{int16} <[cart](*cart)>{bigdecimal} <[payment](*payment-orders)>{bigdecimal} <[tariffName](*tariff-name)>{enum} <[tariffRate](*tariff-rate)>{bigdecimal} {int64} ... ``` {% endlist %} Описание параметров: #| || **Параметр для формата JSON** | **Параметр для формата XML** | **Тип** | **Описание** || || | `result` | | Ответ. Параметр возвращается только для формата XML. || || **Параметры, вложенные в `result`** | > | > | > || || `status` | `status` | Enum | Статус выполнения запроса: - `OK` — запрос выполнен успешно. - `ERROR` — произошла ошибка. Для формата XML является атрибутом параметра `result`. || || `orders` | `orders` | | Список заказов. || || **Параметры, вложенные в `orders`** | > | > | > || || | `order` | | Информация о заказе. Параметр возвращается только для формата XML. || || **Параметры, вложенные в `orders` / `order`** | > | > | > || || `clid` | `clid` | Int64 | Ваш идентификатор в реферальной программе. || || `vid` | `vid` | String | Дополнительный идентификатор инструмента монетизации, с которым покупатель взаимодействовал перед оформлением заказа на Маркете. || || `promocode` | `promocode` | String | Реферальный промокод, который покупатель указал в заказе. || || `orderId` | `orderId` | Int64 | Номер заказа. || || `dateCreated` | `dateCreated` | Datetime | Дата и время создания заказа. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). || || `dateUpdated` | `dateUpdated` | Datetime | Дата и время последнего изменения статуса заказа. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). || || `status` | `status` | Enum | Статус заказа: - `NEW` — в обработке: покупатель оформил заказ, но пока не получил его. - `ON_HOLD` — ждет подтверждения: покупатель получил заказ, но со дня получения не прошло 14 дней. - `APPROVED` — подтвержден: прошло две недели со дня получения заказа. - `CANCELLED` — вознаграждение за заказ не выплачивается. Информация о причинах отмены указана в параметре `additionalInfo`. || || `additionalInfo` | `additionalInfo` | | Список причин, по которым вознаграждение за заказ не выплачивается. Возвращается, только если параметр `status` имеет значение `CANCELLED`. || || `cart` | `cart` | BigDecimal | Сумма заказа в рублях. || || `payment` | `payment` | BigDecimal | Сумма вознаграждения за заказ в рублях. || || `tariff` | `tariff` | Enum | Поле больше не поддерживается. || || `items` | `items` | | Список товаров в заказе. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. || || **Параметры, вложенные в `additionalInfo`** | > | > | > || || `info` | `info` | | Код причины, по которой вознаграждение за заказ не выплачивается: - `ABUSE` — нарушение связано с поведением покупателя: - Превысил количество покупок конкретного товара или группы товаров из одной категории в 2,5 раза. Рассчитывается относительно средних показателей сервиса за день, неделю или месяц. - Использовал купоны, которые принадлежат одному покупателю, с разных аккаунтов. - Оформил заказ с шести и более разных аккаунтов, которые принадлежат одному покупателю. - `ALL_ITEMS_RETURNED` — покупатель создал заявку на возврат в течение 14 дней после получения заказа, даже если потом не вернул по ней товары. Если он возвращает только часть товаров из заказа, за остальные вознаграждение будет начислено. - `BANNED_SOURCE` — покупатель перешел с [запрещенного источника трафика](https://yandex.ru/support/market-distr/ru/rules#not-paid) и оформил заказ на Маркете. - `BUYER_CANCEL` — покупатель отменил заказ. - `FULL_CART_COUPON` — покупатель сначала добавил товары в корзину на Маркете и затем перешел на агрегатор купонов или промокодов, чтобы получить скидку на свой заказ. - `MARKET_CANCEL` — Маркет отменил заказ из-за технической ошибки. - `ORDER_CREATION_EXPIRED` — покупатель не оплатил заказ. - `ORDER_NOT_REPURCHASED` — покупатель не забрал заказ. - `PARTNER_PROMO_CODE` — покупатель применил промокод другого партнера. - `REFERRAL_PROMOCODE` — покупатель применил реферальный промокод. - `SELLER_CANCEL` — магазин отменил заказ. - `VIOLATION_TERMS_OF_USE` — покупатель нарушил [правила использования сервиса](https://yandex.ru/legal/market_termsofuse/). Подробнее см. в разделе [Вознаграждение за заказы на Маркете](https://yandex.ru/support/market-distr/ru/terms) Справки реферальной программы. Возвращается, только если параметр `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 | Поле больше не поддерживается. || || `tariffRate` | `tariffRate` | BigDecimal | Доля от общей стоимости всех единиц товара в заказе, выплачиваемая как вознаграждение. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. || || `osku` | `osku` | Int64 | Артикул товара на Яндекс Маркете. || |# ## Ошибки {#errors} В случае ошибки сервер возвращает HTTP‑код ответа и [краткое описание ошибки](https://yandex.com/support/market-distr/ru/api/concepts/error-codes.md). ## Примеры {#examples} {% list tabs %} - JSON Запрос: ```bash curl -i \ -H 'Authorization: OAuth ' \ 'https://api.content.market.yandex.ru/v3/affiliate'\ '/orders'\ '?clid=2310490'\ '&status=APPROVED'\ '&format=json' ``` Ответ: ```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, "osku": 1234567890 }, { "itemId": 1, "itemCount": 2, "cart": 554.00, "payment": 44.87, "tariffName": "KIDS", "tariffRate": 0.081, "osku": 1234567890 } ] }, { "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, "osku": 1234567890 } ] } ] } ``` - XML Запрос: ```bash curl -i \ -H 'Authorization: OAuth ' \ 'https://api.content.market.yandex.ru/v3/affiliate'\ '/orders'\ '?clid=2310490'\ '&status=APPROVED'\ '&format=xml' ``` Ответ: ```xml HTTP/1.1 200 OK Date: Fri, 17 Jul 2020 07:17:08 GMT Content-Type: application/xml;charset=utf-8 ... 2310490 764 PROMOCODE-AF 13659638 2020-06-30T15:18:34 2020-07-15T11:42:35 APPROVED 1117.00 94.41 general 0 1 563.00 49.54 FASHION 0.088 15241254123 1 2 554.00 44.87 KIDS 0.081 15241222123 2310490 533 13548230 2020-06-27T18:32:43 2020-07-13T13:07:10 APPROVED 200.00 14.00 general 0 2 200.00 14.00 DIY 0.07 512214211233 ``` {% endlist %} [*status]: Статус заказа: - `NEW` — в обработке: покупатель оформил заказ, но пока не получил его. - `ON_HOLD` — ждет подтверждения: покупатель получил заказ, но со дня получения не прошло 14 дней. - `APPROVED` — подтвержден: прошло две недели со дня получения заказа. - `CANCELLED` — вознаграждение за заказ не выплачивается. Информация о причинах отмены указана в параметре `additionalInfo`. [*enum]: Код причины, по которой вознаграждение за заказ не выплачивается: - `ABUSE` — нарушение связано с поведением покупателя: - Превысил количество покупок конкретного товара или группы товаров из одной категории в 2,5 раза. Рассчитывается относительно средних показателей сервиса за день, неделю или месяц. - Использовал купоны, которые принадлежат одному покупателю, с разных аккаунтов. - Оформил заказ с шести и более разных аккаунтов, которые принадлежат одному покупателю. - `ALL_ITEMS_RETURNED` — покупатель создал заявку на возврат в течение 14 дней после получения заказа, даже если потом не вернул по ней товары. Если он возвращает только часть товаров из заказа, за остальные вознаграждение будет начислено. - `BANNED_REGIONS` — покупатель оформил заказ на Маркете с доставкой в регион, которого нет в списке. {% cut "Список регионов" %} - Москва и Московская область - Санкт-Петербург и Ленинградская область - Воронежская область - Краснодарский край - Красноярский край - Нижегородская область - Новосибирская область - Пермский край - Республика Башкортостан - Республика Татарстан - Ростовская область - Самарская область - Свердловская область - Челябинская область {% endcut %} - `BANNED_SOURCE` — покупатель перешел с [запрещенного источника трафика](https://yandex.ru/support/market-distr/ru/rules#not-paid) и оформил заказ на Маркете. - `BUYER_CANCEL` — покупатель отменил заказ. - `FULL_CART_COUPON` — покупатель сначала добавил товары в корзину на Маркете и затем перешел на агрегатор купонов или промокодов, чтобы получить скидку на свой заказ. - `MARKET_CANCEL` — Маркет отменил заказ из-за технической ошибки. - `ORDER_CREATION_EXPIRED` — покупатель не оплатил заказ. - `ORDER_NOT_REPURCHASED` — покупатель не забрал заказ. - `PARTNER_PROMO_CODE` — покупатель применил промокод другого партнера. - `REFERRAL_PROMOCODE` — покупатель применил реферальный промокод. - `SELLER_CANCEL` — магазин отменил заказ. - `VIOLATION_TERMS_OF_USE` — покупатель нарушил [правила использования сервиса](https://yandex.ru/legal/market_termsofuse/). Подробнее см. в разделе [Вознаграждение за заказы на Маркете](https://yandex.ru/support/market-distr/ru/terms) Справки реферальной программы. Возвращается, только если параметр `status` имеет значение `CANCELLED`. Параметр возвращается только для формата XML. Для формата JSON возвращается код в виде строки. [*cart]: Общая стоимость всех единиц товара в заказе. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. [*cart-orders]: Сумма заказа в рублях. [*result]: Ответ. Параметр возвращается только для формата XML. [*orders]: Список заказов. [*order]: Информация о заказе. Параметр возвращается только для формата XML. [*clid]: Ваш идентификатор в реферальной программе. [*vid]: Дополнительный идентификатор инструмента монетизации, с которым покупатель взаимодействовал перед оформлением заказа на Маркете. [*order-id]: Номер заказа. [*date-created]: Дата и время создания заказа. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). [*date-updated]: Дата и время последнего изменения статуса заказа. Формат даты и времени: [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, `2017-11-21T00:00:00`. Часовой пояс — UTC+03:00 (Москва). [*additional-info]: Список причин, по которым вознаграждение за заказ не выплачивается. Возвращается, только если параметр `status` имеет значение `CANCELLED`. [*payment]: Сумма вознаграждения за заказ в рублях. [*payment-orders]: Общее вознаграждение за все единицы товара в заказе. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. [*tariff]: Поле больше не поддерживается. [*items-orders]: Список товаров в заказе. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. [*item-orders]: Информация о товаре. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. Параметр возвращается только для формата XML. [*item-id-orders]: Номер товара в заказе. Нумерация начинается с `0`. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. [*item-count-orders]: Количество единиц товара в заказе, за которые должно быть выплачено вознаграждение. За товары, которые покупатель начал возвращать в течение двух недель со дня получения, вознаграждение не выплачивается. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. [*tariff-name]: Поле больше не поддерживается. [*tariff-rate]: Доля от общей стоимости всех единиц товара в заказе, выплачиваемая как вознаграждение. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`. [*promo-order]: Реферальный промокод, который покупатель указал в заказе.