Получение отчетов по заказам

Возвращает данные о текущих заказах, которые совершил пользователь после перехода с партнерского ресурса на Яндекс Путешествия.

Можно сформировать следующие отчеты, которые фильтруются по времени:

GET https://whitelabel.travel.yandex-net.ru/reports/orders/by_created_date — создания заказа;

GET https://whitelabel.travel.yandex-net.ru/reports/orders/by_updated_date — последнего изменения данных заказа;

GET https://whitelabel.travel.yandex-net.ru/reports/orders/by_billing_date — выгрузки заказа в систему оплаты. Обычно это следующий день после оказания услуги, например, для отельного заказа — это выезд из отеля. Возможны ситуации, когда старые заказы отправляются в систему оплаты позже.

Форматы запроса и ответа одинаковы для всех трех методов, различается только способ фильтрации — он указывается в URL запроса.

Формат запроса

Например, формат запроса для получения отчета по времени создания заказа:

GET https://whitelabel.travel.yandex-net.ru/reports/orders/by_created_date
  ? dateFrom=<date>
  & dateTo=<date>
  & [limit=<integer>]
  & [offset=<integer>]

Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Параметры запроса

Параметр

Описание

dateFrom*

Дата, начиная с которой будут отображаться заказы в отчете, в формате YYYY-MM-DD.

dateTo*

Дата, до которой будут отображаться заказы в отчете, в формате YYYY-MM-DD.

limit

Ограничение на количество заказов в ответе. Максимальное значение — 5000.

offset

Порядковый номер, начиная с которого будут отображаться заказы в ответе. Значение по умолчанию — 0.

* Обязательный параметр

Пример запроса

https://whitelabel.travel.yandex-net.ru/reports/orders/by_created_date?dateFrom=2022-10-10&dateTo=2022-12-10

Формат ответа

{
  "page": {
    "limit": (integer),
    "offset": (integer)
  },
  "orders": [
    {
      "utm_campaign": "(string)",
      "partner_uid": "(string)",
      "affiliate_vid": "(string)",
      "traffic_type": "(string)",
      "country_type": "(string)",
      "partner_order_id": "(string)",
      "state": "(string)",
      "created_at": "(string)",
      "updated_at": "(string)",
      "billed_at": "(string)",
      "order_amount": (integer),
      "fee_amount": (integer),
      "fee_amount_without_nds": (integer),
      "currency": "(string)",
      "type": "(string)",
      "booked_on_yandex": (boolean),
      "checkin_date": "(string)",
      "checkout_date": "(string)",
      "country": "(string)",
      "city": "(string)",
      "hotel_name": "(string)",
      "partner_request_id": "(string)",
      "clid": "(string)",
      "partner_points": {
        "amount": (integer)
      },
      "partner_customer_number": "(string)",
      "source_platform": "(string)"
    }
  ]
}

Параметры ответа

Параметр

Тип

Описание

page

array

Параметры отображаемой страницы пейджинга, указанные в запросе.

orders

array

Список заказов.

page array

limit

integer

Ограничение на количество заказов в ответе.

offset

integer

Порядковый номер заказа, начиная с которого выводится результат запроса.

orders array

utm_campaign

string

Параметр рекламной кампании, используется для аналитики. Для поддоменов не заполняется.

partner_uid

string

Уникальный идентификатор заказа, заполняется для части партнеров. Для поддоменов не заполняется

affiliate_vid

string

идентификатор подпартнера внутри партнера. Для поддоменов не заполняется.

traffic_type

string

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

country_type

string

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

partner_order_id

string

Идентификатор заказа у Яндекса или у click-out партнера.

state

string

Статус заказа. Возможные значения:

  • HOLD— забронирован;
  • CANCELED — отменен;
  • CONFIRMED — гость выехал.

created_at

string

Дата и время бронирования в формате UTC.

updated_at

string

Дата и время обновления заказа — например, службой поддержки, в формате UTC.

billed_at

string

Дата и время выгрузки заказа в систему оплаты для аффилятных партнеров, в формате UTC.

order_amount

integer

Cумма заказа.

fee_amount

integer

Сумма, перечисляемая поддомену, с НДС.

fee_amount_without_nds

integer

Сумма, перечисляемая поддомену, без НДС.

currency

string

Валюта, в которой передаются order_amount и fee_amount. Возможное значение — RUB.

type

string

Тип заказа. Возможные значения:

  • hotels — отели;
  • train — поезда;
  • avia — самолеты.

booked_on_yandex

boolean

Заказ забронирован через Яндекс. Для click-out заказов значение false.

checkin_date

string

Дата заезда в формате YYYY-MM-DD.

checkout_date

string

Дата выезда в формате YYYY-MM-DD.

country

string

Страна, в которой находится отель.

city

string

Город, в котором находится отель.

hotel_name

string

Название отеля.

partner_request_id

string

Идентификатор перехода с сайта поддомена.

clid

string

Clid, с которым был сделан заказ.

partner_points

array

Бонусы партнера, обещанные покупателю.

partner_customer_number

string

Идентификатор покупателя в программе лояльности партнера.

source_platform

string

Платформа, с которой был сделан заказ. Параметр возвращается только при значении "type": "hotels" Возможные значения:

  • MOBILE_APP — мобильное приложение;
  • WEB — браузер;
  • API — запрос по API;
  • OTHER — другой способ.

partner_points array

amount

integer

Сумма бонусов партнера.

Пример ответа

{
  "page": {
    "limit": 100,
    "offset": 0
  },
  "orders": [
    {
      "utm_campaign": "xxx",
      "partner_uid": "40eef6f267c84be588d26c87b8-11711",
      "affiliate_vid": "52519",
      "traffic_type": "marketing",
      "country_type": "expensive",
      "partner_order_id": "YA-1234-1234-1234",
      "state": "CONFIRMED",
      "created_at": "2022-04-27T12:30:00",
      "updated_at": "2022-04-27T13:40:00",
      "billed_at": "2022-04-27T13:40:00",
      "order_amount": 9999.99,
      "fee_amount": 999.99,
      "fee_amount_without_nds": 999.99,
      "currency": "RUB",
      "type": "hotels",
      "booked_on_yandex": true,
      "checkin_date": "2022-05-06",
      "checkout_date": "2022-05-07",
      "country": "Россия",
      "city": "Владивосток",
      "hotel_name": "У Дяди Васи",
      "partner_request_id": "xxx",
      "clid": "888888",
      "partner_points": {
        "amount": 999
      },
      "partner_customer_number": "xxxxx",
    }
  ]
}
Написать в службу поддержки

Начало периода формирования отчета, в формате YYYY-MM-DD.

Окончание периода, за который формируется отчет, в формате YYYY-MM-DD.

Ограничение на количество заказов в ответе. Максимальное значение — 5000.

Порядковый номер, начиная с которого будут отображаться заказы в ответе. Значение по умолчанию — 0.

Предыдущая
Запуск процесса отмены заказа
Следующая
История обновлений API