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

Возвращает массив заказов.

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

POST https://api.tickets.yandex.net/api/agent/\
 ? action=order.list\
 & auth=<string>\
 & city_id=<number>\
 & [status=<number>]\
 & [start_date=<string>]\
 & [end_date=<string>]\
 & [customer_id=<number>]\
 & [email=<string>]\
 & [phone=<string>]

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

Query-параметр Описание
action string
Идентификатор запроса.
auth string
Идентификатор внешней системы.
city_id number
Идентификатор города.
status number
Статус заказа.
Возможные значения:
  • 0 — аннулирован;
  • 1 — продан;
  • 2 — бронь;
  • 3 — доставка.
    start_date string
    Дата в формате yyyy-mm-dd, начиная с которой (включительно) заказы возвращаются в ответе.
    end_date string
    Дата в формате yyyy-mm-dd, до которой (включительно) заказы возвращаются в ответе.
    customer_id number
    Идентификатор покупателя.
    email string
    Электронная почта покупателя.
    phone string
    Номер телефона покупателя.

    Особенности:
    • Номера телефонов хранятся в базе данных в ненормализованном виде.
      Пример. +79999999999 и 7 (999) 999 99 99 — разные номера.
    • Знак + в теле запроса обнозначается символами %2B. Символ + интерпретируется как пробел.
      Пример. Чтобы найти заказы по номеру телефона +79260000000, выполните запрос с параметром phone=%2B79260000000. Запрос с параметром phone=+79260000000 выдаст заказы по номеру 79260000000.

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

    JSON

    {
  "status": string,
  "result": [
    {
      "id": number,
      "status": number,
      "order_date": string,
      "annulate_date": string,
      "utm_source": string,
      "tickets_count": number,
      "tickets_sum": number,
      "tickets_fee": number,
    }
  ]
}

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

    Параметр Описание
    status string
    Статус выполнения запроса.
    Возможные значения:
    • 0 — запрос выполнен;
    • 1 — произошла ошибка.
      result[] [object]
      Результат выполнения запроса.
      result[].id number
      Идентификатор заказа.
      result[].status number
      Статус заказа.
      Возможные значения:
      • 0 — аннулирован;
      • 1 — продан;
      • 2 — бронь;
      • 3 — доставка.
        result[].order_date string
        Дата создания заказа.
        result[].annulate_date string
        Дата аннулирования заказа.
        result[].utm_source string
        UTM-метка заказа.
        result[].tickets_count number
        Количество билетов в заказе.
        result[].tickets_sum number
        Сумма заказа.
        result[].tickets_fee number
        Сумма сервисного сбора.
        Предыдущая
        Информация о заказе
        Следующая
        Список проданных билетов