GetFavoritePeriod

[POST] …/v1/DocCheque/GetFavoritePeriod

Возвращает список чеков в период, который задаётся настройкой "Период предпочитаемых покупок". Данный метод нужен для получения списка чеков в карту покупателя.

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

Название Тип данных Обязательность Описание
uuids Array of String Необязательный Массив UUID чеков
cashier_ids Array of Int64 Необязательный Массив ID кассиров
seller_ids Array of Int64 Необязательный Массив ID продавцов
card_ids Array of Int64 Необязательный Массив ID карт покупателей
customer_ids Array of Int64 Необязательный Массив ID покупателей
session_uuid String Необязательный UUID смены, к которой привязан чек
status Enum Необязательный Статус чека: <Opened | 1> - Открыт, <Paying | 2> - В процессе оплаты, <Closed | 3> - Закрыт, <Delayed | 4> - Отложен, <DelayedPayment | 5> - Отложен в процессе оплаты, <Canceled | 6> - Аннулирован
is_return Boolean Необязательный Метка о том, что чек является чеком возврата
is_fiscal Boolean Необязательный Имеет ли чек фискальный признак: true - имеет фискальный признак, false - не имеет фискальный признак. Под фискальным признаком понимается наличие qr-code с url в чеке
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
limit Int32 Необязательный Количество элементов выборки, возвращаемых при запросе
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Uuid | 1> - UUID чека, <Date | 2> - Дата чека, <Code | 3> - Код чека, <Status | 4> - Статус чека, <Session | 5> - Код кассовой смены, <CashierName | 6> - ФИО кассира, <IsRetunr | 7> - Чек продажи или возврата, <SellerName | 8> - ФИО продавца, <ReturnReasonId | 9> - ID причины возврата, <RetailCardBarcodeValue | 10> - Штрих-код карты покупателя, <Amount | 11> - Сумма чека, <AgregateStatus | 12> - Агрегирован, <LastUpdate | 13> - Последнее изменение в Unix time
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "uuid": "a0ac4d96-f193-4c15-8c9d-5e9e5fe78307",
    "code": "1-0000210",
    "session_uuid": "d80432cf-221f-4f0c-a3b7-00d9c9293591",
    "cashier_ids": [
        1
    ],
    "seller_ids": [
        2
    ],
    "card_ids": [
        3
    ],
    "doc_order_delivery_id": 0,
    "statuses": "Closed",
    "start_date": 1635860191,
    "end_date": 1635860991,
    "is_return": true,
    "return_reason": 1,
    "is_fiscal": true,
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "limit": 1,
    "offset": 1
}

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

Название Тип данных Описание
result Array of DocCheque Массив чеков за период предпочетаемых покупок

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

{
    "ok": true,
    "result": [
        {
            "uuid": "a0ac4d96-f193-4c15-8c9d-5e9e5fe78307",
            "date": 1635860191,
            "code": "1-0000210",
            "status": "Closed",
            "session": "d80432cf-221f-4f0c-a3b7-00d9c9293591",
            "cashier": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "is_return": true,
            "seller": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "return_reason": {
                "id": 1,
                "name": "Не понравилось",
                "description": "example",
                "enabled": true,
                "last_update": 1593611279
            },
            "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
            },
            "amount": 1.1,
            "agregate_status": "Agregated",
            "last_update": 1641537703
        }
    ],
    "next_offset": 1,
    "total": 1
}