Отчет по одному заказу

Описание

GET /order

Возвращает заказ, оформленный покупателем после взаимодействия с вашими инструментами монетизации: например, после кликов по партнерским ссылкам.

При желании вы также можете получить отчет по нескольким заказам при помощи запроса GET /orders или в личном кабинете Яндекс.Дистрибуции. Подробнее см. в Справке партнерской сети.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/order

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

Параметр	Тип	Значение
Обязательные
`clid`	Int64	Ваш идентификатор в партнерской сети. Передайте идентификатор CLID, по которому вы хотите получить данные о заказе. Для авторизации используется ключ типа «Контентный API», но в запросе нужно указывать CLID того типа, по которому хотите получить статистику по заказу.
`orderID`	Int64	Номер заказа, по которому нужно получить отчет.
Необязательные
`format`	Enum	Формат выходных данных: `json` `xml` Значение по умолчанию: `json`.
`total`	Boolean	Возвращать ли обобщенную информацию о заказе, без списка товаров: `true` — да. `false` — нет. Значение по умолчанию: `false`.

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

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

JSON

XML

{
  "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	Статус выполнения запроса: `OK` — запрос выполнен успешно. `ERROR` — произошла ошибка. Для формата 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	Статус заказа: `NEW` — в обработке: покупатель оформил заказ, но пока не получил его. `ON_HOLD` — ждет подтверждения: покупатель получил заказ, но со дня получения не прошло 14 дней. `APPROVED` — подтвержден: прошло две недели со дня получения заказа. `CANCELLED` — вознаграждение за заказ не выплачивается. Информация о причинах отмены указана в параметре `additionalInfo`.
`additionalInfo`	`additionalInfo`		Список причин, по которым вознаграждение за заказ не выплачивается. Возвращается, только если параметр `status` имеет значение `CANCELLED`.
`cart`	`cart`	BigDecimal	Сумма заказа в рублях.
`payment`	`payment`	BigDecimal	Сумма вознаграждения за заказ в рублях.
`tariff`	`tariff`	Enum	Тариф, по которому выплачивается вознаграждение за заказ: Для заказов, оформленных с 22 июня 2020 года `general` — общий тариф: вознаграждение зависит только от тарифной категории, которая возвращается в параметре `tariffName` для каждого товара (если входной параметр `total` не указан или в нем указано значение `false`). Для заказов, оформленных до 22 июня 2020 года `new` — двойной тариф: покупатель оформил заказ впервые. `old` — обычный тариф: покупатель уже оформлял заказы ранее. Подробнее о расчете вознаграждений см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети.
`items`	`items`		Список товаров в заказе. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`.
Параметры, вложенные в `additionalInfo`
	`info`		Код причины, по которой вознаграждение за заказ не выплачивается: `ABUSE` — нарушение связано с поведением покупателя: Превысил количество покупок конкретного товара или группы товаров из одной категории в 2,5 раза. Рассчитывается относительно средних показателей сервиса за день, неделю или месяц. Использовал купоны, которые принадлежат одному покупателю, с разных аккаунтов. Оформил заказ с шести и более разных аккаунтов, которые принадлежат одному покупателю. `ALL_ITEMS_RETURNED` — покупатель создал заявку на возврат в течение 14 дней после получения заказа, даже если потом не вернул по ней товары. Если он возвращает только часть товаров из заказа, за остальные вознаграждение будет начислено. `BANNED_REGIONS` — покупатель оформил заказ на Маркете с доставкой в регион, которого нет в списке. Список регионов Москва и Московская область Санкт-Петербург и Ленинградская область Воронежская область Краснодарский край Красноярский край Нижегородская область Новосибирская область Пермский край Республика Башкортостан Республика Татарстан Ростовская область Самарская область Свердловская область Челябинская область `BANNED_SOURCE` — покупатель перешел с запрещенного источника трафика и оформил заказ на Маркете. `BUYER_CANCEL` — покупатель отменил заказ. `FULL_CART_COUPON` — покупатель сначала добавил товары в корзину на Маркете и затем перешел на агрегатор купонов или промокодов, чтобы получить скидку на свой заказ. `MARKET_CANCEL` — Маркет отменил заказ из-за технической ошибки. `ORDER_CREATION_EXPIRED` — покупатель не оплатил заказ. `ORDER_NOT_REPURCHASED` — покупатель не забрал заказ. `PARTNER_PROMO_CODE` — покупатель применил промокод другого партнера. `REFERRAL_PROMOCODE` — покупатель применил реферальный промокод. Описание реферальной программы. `SELLER_CANCEL` — магазин отменил заказ. `VIOLATION_TERMS_OF_USE` — покупатель нарушил правила использования сервиса. Подробнее см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. Возвращается, только если параметр `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	Код тарифной категории, к которой относится товар: Для заказов, оформленных с 22 июня 2020 года `CEHAC` — электроника и бытовая техника. `DIY` — DIY-товары. `FASHION` — мода. `FMCG` — товары повседневного спроса. `KIDS` — детские товары. `PHARMA` — товары для здоровья. `ALL`, `UNKNOWN` — другие товары. Для заказов, оформленных до 22 июня 2020 года `CEHAC` — бытовая техника; электроника; компьютерная техника; системы нагревания, электронные испарители и аксессуары (кроме стиков). `STICKS` — стики. `ALL` — другие товары. Подробнее см. в разделе Вознаграждение за заказы на Маркете Справки партнерской сети. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`.
`tariffRate`	`tariffRate`	BigDecimal	Доля от общей стоимости всех единиц товара в заказе, выплачиваемая как вознаграждение. Возвращается, только если входной параметр `total` не указан или в нем указано значение `false`.

Ошибки

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

Примеры

JSON

XML

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/order'\
'?clid=2310490'\
'&orderId=13659638'\
'&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
        }
      ]
    }
  ]
}

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/order'\
'?clid=2310490'\
'&orderId=13659638'\
'&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>
  </orders>
</result>

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

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