Список заказов
Возвращает массив заказов.
Формат запроса
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 Статус заказа. Возможные значения:
|
start_date | string Дата в формате yyyy-mm-dd, начиная с которой (включительно) заказы возвращаются в ответе. |
end_date | string Дата в формате yyyy-mm-dd, до которой (включительно) заказы возвращаются в ответе. |
customer_id | number Идентификатор покупателя. |
string Электронная почта покупателя. |
|
phone | string Номер телефона покупателя. Особенности:
|
Формат ответа
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 Статус выполнения запроса. Возможные значения:
|
result[] | [object] Результат выполнения запроса. |
result[].id | number Идентификатор заказа. |
result[].status | number Статус заказа. Возможные значения:
|
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 Сумма сервисного сбора. |
Была ли статья полезна?
Предыдущая
Следующая