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

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

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

GET https://api.tickets.yandex.net/api/crm\
 ? action=crm.order.list\
 & auth=<string>\
 & city_id=<number>\
 & [order_id=<number>]\
 & [start_date=<string>]\
 & [end_date=<string>]\
 & [status=<number>]

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

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

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

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

    JSON

    {
  "status": string,
  "result": [
    [
      {
        "id": number,
        "customer_id": number,
        "status": number,
        "order_date": string,
        "event_id": number,
        "season_id": number,
        "tickets_count": number,
        "seasons_count": number,
        "sum": number,
        "fee": number,
        "sale_type": number
      }
    ]
  ]
}

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

    Параметр Описание
    status string
    Статус выполнения запроса.
    Возможные значения:
    • 0 — запрос выполнен;
    • 1 — произошла ошибка.
      result[] [object]
      Результат выполнения запроса.
      result[].id number
      Идентификатор заказа.
      result[].customer_id number
      Идентификатор покупателя.
      result[].status number
      Статус заказа.
      Возможные значения:
      • 0 — аннулирован;
      • 1 — продан;
      • 2 — бронь;
      • 3 — доставка.
        result[].order_date string
        Дата создания заказа в формате YYYY-MM-DD hh:mm:ss±hhmm.
        result[].event_id number
        Идентификатор события.
        result[].season_id number
        Идентификатор абонемента.
        result[].tickets_count number
        Количество билетов в заказе.
        result[].seasons_count number
        Количество абонементов в заказе.
        result[].sum number
        Сумма заказа.
        result[].fee number
        Сумма сервисного сбора.
        result[].sale_type number
        Тип продажи заказа.
        Возможные значения:
        • 0 — аннулирован;
        • 1 — пригласительные по 0 рублей;
        • 2 — в кассе;
        • 3 — в личном кабинете;
        • 4 — по шлюзу.

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

          {
  "status": "0",
  "result": [
    [
      {
        "id": 9444042,
        "customer_id": 9444041,
        "status": 1,
        "order_date": "2023-05-24 15:05:27+0300",
        "event_id": 9443939,
        "season_id": 0,
        "tickets_count": 13,
        "seasons_count": 0,
        "sum": 12020,
        "fee": 0,
        "sale_type": 3
      }
    ],
    [
      {
        "id": 9350468,
        "customer_id": 9350467,
        "status": 0,
        "order_date": "2023-05-18 11:23:02+0300",
        "event_id": 0,
        "season_id": 0,
        "tickets_count": 0,
        "seasons_count": 0,
        "sum": 0,
        "fee": 140,
        "sale_type": 4
      }
    ]
  ]
}
          Предыдущая
          Отчет по событиям
          Следующая
          Информация о заказе