Get

[POST] …/v1/DocOrderDelivery/Get или [POST] …/v1/POS/DocOrderDelivery/Get

Возвращает документы розничных заказов.

Входные параметры

Название Тип данных Обязательность Описание
start_date Int64 Необязательный Дата начала периода в формате Unix time
end_date Int64 Необязательный Дата окончания периода в формате Unix time
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 Необязательный Код заказа во внешней системе
blocked Boolean Необязательный Состояние блокировки для редактирования: true - Заблокирован, false - Разблокировин
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка для поиска
deleted_mark Boolean Необязательный Пометка на удаление: true - Помечен на удаление, false - Не помечен на удаление
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки
SortOrders

Модель сортировки выходных параметров.

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Date | 1> - Дата документа, <Code | 2> - Код документа, <Stock | 3> - Наименование склада, <OperatingCash | 4> - Код кассы, <Customer | 5> - ФИО покупателя, <Card | 6> - Штрих-код карты покупателя, <CurrencyName | 7> - Наименование валюты, <OrderStatusName | 8> - Статус, <Amount | 9> - Сумма, <From | 10> - Источник заказа
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "start_date": 1534153454,
    "end_date": 1534157896,
    "code": "00001",
    "ids": [1],
    "status_ids": [1],
    "stock_ids": [1],
    "customer_ids": [1],
    "operating_cash_ids": [1],
    "from_ids": [1],
    "external_code": "example123",
    "blocked": false,
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "deleted_mark": false,
    "limit": 1,
    "offset": 1
}

Выходные параметры

Название Тип данных Описание
result Array of DocOrderDelivery Массив документов розничных заказов
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 20,
            "date": 1575552258,
            "code": "ODL-0000020",
            "stock": {
                "id": 1,
                "name": "Новомосковская",
                "address": "example",
                "firm": {
                    "id": 1,
                    "group": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Предприятия",
                        "child_count": 0,
                        "last_update": 1715233269
                    },
                    "deleted_mark": false,
                    "last_update": 1715863600,
                    "name": "REGOS",
                    "fullname": "ООО \"REGOS Software\"",
                    "boss_name": "Андрей",
                    "address": "Мукими, 8А",
                    "phones": "+998987654321",
                    "description": "EasyTrade successor",
                    "inn": "305930137",
                    "bank_name": "Ипак Йули",
                    "mfo": "01101",
                    "rs": "22125489632541254782",
                    "oked": "62090",
                    "vat_index": "1325489654785"
                },
                "description": "example",
                "deleted_mark": false,
                "last_update": 1705583155
            },
            "customer": {
                "id": 1,
                "region": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Samarkand",
                    "last_update": 1718702656
                },
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Покупатели",
                    "last_update": 1718202013,
                    "child_count": 0
                },
                "last_purchase": 0,
                "deleted_mark": false,
                "last_update": 1718711661,
                "first_name": "Megan",
                "last_name": "Williams",
                "middle_name": "Ann",
                "full_name": "Megan Ann Williams",
                "sex": "Female",
                "date_of_birth": "1964-12-22",
                "address": "Feliciashire",
                "main_phone": "998952087619",
                "phones": "+998952087619",
                "email": null,
                "refer_id": 1,
                "description": "Customer 4"
            },
            "card": {
                "id": 2,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "карты 5",
                    "child_count": 0,
                    "last_update": 1655116137
                },
                "customer": {
                    "id": 1,
                    "region": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Samarkand",
                        "last_update": 1718702656
                    },
                    "group": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Покупатели",
                        "last_update": 1718202013,
                        "child_count": 0
                    },
                    "last_purchase": 0,
                    "deleted_mark": false,
                    "last_update": 1718711661,
                    "first_name": "Megan",
                    "last_name": "Williams",
                    "middle_name": "Ann",
                    "full_name": "Megan Ann Williams",
                    "sex": "Female",
                    "date_of_birth": "1964-12-22",
                    "address": "Feliciashire",
                    "main_phone": "998952087619",
                    "phones": "+998952087619",
                    "email": null,
                    "refer_id": 1,
                    "description": "Customer 4"
                },
                "barcode_value": "12345678",
                "barcode_type": {
                    "id": 1,
                    "name": "EAN13",
                    "last_update": 1533817902
                },
                "promo": {
                    "id": 1,
                    "name": "Накопительная",
                    "type": {
                        "id": 1,
                        "name": "Бонусная система",
                        "last_update": 1664715033
                    },
                    "active": false,
                    "days": [
                        1
                    ],
                    "start_time": "00:00:00",
                    "end_time": "23:59:00",
                    "start_date": "2023-12-11",
                    "end_date": "2024-01-11",
                    "description": null,
                    "sub_type": 0,
                    "priority": 1,
                    "last_update": 1719234620
                },
                "bonus_amount": 10000.1,
                "date": 1541331489,
                "unlimited": true,
                "last_purchase": 1541331489,
                "expiry_date": "2018-12-04",
                "enabled": true,
                "last_update": 1542217079
            },
            "operating_cash_id": 1,
            "amount": 1.1,
            "status": {
                "id": 1,
                "document_type_id": 1,
                "name": "В ожидании",
                "order": 1,
                "last_update": 1533619486
            },
            "delivery_date": 1575486000,
            "description": "example",
            "address": "Toshkent sh., Yakkasaroy tum., Abdulla Qahhor 2a",
            "phone": "+998901234567",
            "external_code": "example",
            "from": {
                "id": 1,
                "name": "example",
                "deleted": false,
                "last_update": 1534151629
            },
            "location": {
                "longitude": 48.8584,
                "latitude": 2.2945
            },
            "delivery_type": {
                "id": 1,
                "name": "Самовывоз",
                "last_update": 1534151629
            },
            "courier": {
                "id": 1,
                "name": "Александр",
                "description": "Курьер",
                "last_update": 1534151629
            },
            "price_type": {
                "id": 1,
                "name": "example",
                "round_to": 0.00,
                "markup": 0.25,
                "max_discount": 0.2,
                "currency": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "UZS",
                    "name": "Узбекский сум",
                    "exchange_rate": 1,
                    "is_base": true,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "currency_additional": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "USD",
                    "name": "Dolar",
                    "exchange_rate": 1.1,
                    "is_base": false,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "last_update": 1700000000
            },
            "qrcodeurl": "https://ofd.soliq.uz/check?t=VG379042759526&r=486&c=2023052637574&s=374693627483",
            "payment_type": {
                "id": 1,
                "name": "Наличные",
                "account": {
                    "id": 1,
                    "code": "1",
                    "name": "Наличные касса",
                    "currency": {
                        "id": 1,
                        "code_num": 123,
                        "code_chr": "UZS",
                        "name": "Узбекский сум",
                        "exchange_rate": 1.1,
                        "is_base": false,
                        "deleted": false,
                        "last_update": 1533619909
                    },
                    "last_update": 1574150377
                },
                "shortkey": 6,
                "is_cash": true,
                "kkm_code": -1,
                "last_update": 1582629326,
                "enabled": "True",
                "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png"
            },
            "blocked": false,
            "current_user_blocked": false,
            "deleted_mark": false,
            "last_update": 1575562732
        }
    ],
    "next_offset": 1,
    "total": 1
}