[POST] …/v1/DocOrderDelivery/get
Возвращает информацию о документах розничных заказов
Входные параметры
| Название | Тип данных | Обязательность | Описание параметра |
|---|---|---|---|
| start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
| end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
| code | string | Необязательный | Код документа розничных заказов |
| ids | array of int64 | Необязательный | Массив id документов розничных заказов |
| status_ids | array of int64 | Необязательный | Массив id статусов документов |
| stock_ids | array of int64 | Необязательный | Массив id складов |
| customer_ids | array of int64 | Необязательный | Массив id покупателей |
| operating_cash_ids | array of int64 | Необязательный | Массив id касс |
| from_ids | array of int64 | Необязательный | Массив id источников розничных заказов |
| external_code | string | Необязательный | Код заказа во внешней системе |
| sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
| search | string | Необязательный | Строка для поиска |
| limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
| offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
| Название | Тип данных | Описание параметра |
|---|---|---|
| column | enum | Значение для сортировки: Date (Дата), Code (Код документа), Stock (Склад), OperatingCash (Касса), Customer (Покупатель), Card (Карта покупателя), CurrencyName (Валюта), OrderStatusName (Статус заказа), Amount (Количество), From (Источник заказа) |
| direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"code":"00001",
"ids":[1,2,3],
"status_ids":[1,2,3],
"stock_ids":[1,2,3],
"customer_ids":[1,2,3],
"operating_cash_ids":[1,2,3],
"from_ids":[1,2,3],
sort_orders:
[
{
column:'date',
direction:'desc'
}
],
"limit":20,
"offset":3
}Выходные параметры
| Название | Тип данных | Обязательность | Описание параметра |
|---|---|---|---|
| Result | Array of DocOrderDelivery | Обязательный | Массив объектов DocOrderDelivery |
Пример ответа
{
"ok": true,
"result": [
{
"id": 20,
"date": 1575552258,
"code": "ODL-0000020",
"stock": {
"id": 1,
"name": "Торговый зал",
"firm": {
"id": 1,
"group": {
"id": 1,
"parent_id": 0,
"name": "Firm1",
"last_update": 1574145827
},
"deleted_mark": false,
"last_update": 1574145848,
"name": "Regos",
"fullname": null,
"boss_name": null,
"address": null,
"phones": null,
"description": null,
"inn": null,
"bank_name": null,
"mfo": null,
"rs": null,
"oked": null,
"vat_index": null
},
"deleted_mark": false,
"last_update": 1574146590
},
"stock_id": 1,
"customer": {
"id": 2,
"region": null,
"group": {
"id": 1,
"parent_id": 0,
"name": "Regos",
"last_update": 1575006990
},
"deleted_mark": false,
"last_update": 1575552282,
"first_name": "Pokupatel1",
"last_name": "Abc",
"middle_name": null,
"sex": "none",
"date_of_birth": "2019-11-29",
"address": "Toshkent sh., Yakkasaroy tum., Abdulla Qahhor 2a",
"main_phone": "+998901234567",
"phones": "+998990123456",
"refer_id": -1
},
"customer_id": 2,
"card_id": 1,
"card_barcode_value": "2900000000520",
"operating_cash_id": 0,
"amount": 0,
"status": {
"id": 22,
"document_type_id": 22,
"name": "Yangi",
"order": 1,
"last_update": 1574076219
},
"status_id": 22,
"delivery_date": 1575486000,
"description": "test2",
"address": "Toshkent sh., Yakkasaroy tum., Abdulla Qahhor 2a",
"phone": "+998901234567",
"from": {
"id": 1,
"name": "Менеджер",
"deleted": false,
"last_update": 1574081677
},
"from_id": 1,
"price_type": {
"id": 1,
"name": "Розничная",
"round_to": 0.01,
"markup": 0,
"max_discount": 100,
"last_update": 1574145917
},
"price_type_id": 1,
"blocked": false,
"deleted_mark": false,
"last_update": 1575562732
}
],
"next_offset": 1,
"total": 20
}