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

Для получения информации о списке заказов необходимо использовать API GET /api/order. Поддерживаются следующие фильтры:

Ключ

Тип

Описание

franchisees

List[ObjectId]

(Только франчайзер) Список франчайзи, выполнявших продажу

franchisees_ne

List[ObjectId]

(Только франчайзер) Аналогично предыдущему, исключающе

units

List[ObjectId]

Список точек, на которых выполнялась продажа

units_ne

List[ObjectId]

Аналогично предыдущему, исключающе

users

List[ObjectId]

Список сотрудников, выполнявших продажу

users_ne

List[ObjectId]

Аналогично предыдущему, исключающе

clients

List[ObjectId]

Список клиентов, к которым привязана продажа

clients_ne

List[ObjectId]

Аналогично предыдущему, исключающе

prototypes

List[ObjectId]

Список услуг, входивших в продажу

prototypes_ne

List[ObjectId]

Аналогично предыдущему, исключающе

date

date

Дата, в которую выполнялась продажа

begin

datetime

Дата начала фильтрации списка продаж (>=)

end

datetime

Дата конца фильтрации списка продаж (<=)

API использует стандартную схему пагинации.

Предупреждение

Ключ date учитывает временную зону пользователя, выполняющего запрос

Предупреждение

Ключи begin и end ожидают указания временной зоны. Если временная зона не передана, значение трактуется как время в UTC

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

curl -X GET \
https://demo.idealist.one/api/order \
    -H 'Authorization: Bearer persistent 2adbd5dc-38c4-4963-8930-6d75827ff0fe'