GetLoyaltyTransactions

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку

Функція повертає дані про транзакції системи лояльності

Розділ містить методи, необхідні для отримання даних про транзакції по системі лояльності

Опис Отримання даних про транзакції системи лояльності.
Метод POST
URL /POSExternal/GetLoyaltyTransactions



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
    "TransactionFrom": "2023-03-22 15:05:55.763",
    "IsClientDetailNeed": true,
    "IsTransactionItemsNeed": true,
    "ClientPhone": "",
    "ClientEmail": "",
    "CardCode": "",
    "TransactionTypes": ""
}



Типи даних Body
* Параметр Тип Опис
TransactionFrom Datetime Дата і час для фільтру транзакцій
IsClientDetailNeed Bool Чи включати зв'язані анкети, контакти. За замовчуванням не включати, якщо не вказано
IsTransactionItemsNeed Bool Чи включати деталізацію по позиціям транзакцій. За замовчуванням не включати
ClientPhone String Телефон. Якщо не вказано, то не обмежувати
ClientEmail String Електронна пошта
CardCode String Код карти лояльності
TransactionTypes String Типи транзакцій. Перерахувати типи. Можна декілька типів
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": "",
    "Success": true,
    "LoyaltyTransactions": [
        {
            "TransactionID": 0,
            "DateTransaction": "",
            "BillID": 24007,
            "TransactionType": 0,
            "Sum": 0.00,
            "DiscountSum": 340.00,
            "ValuteISOCode": "UAH",
            "PayTypeName": "",
            "PayTypeCode": "",
            "CardID": 14996,
            "CardCode": "1111                                ",
            "TransactionItems": [
                {
                    "ItemID": 58687,
                    "TarifItemID": 58687,
                    "ArticleCode2": "80",
                    "ArticleName": "Тар-тар из тунца 200гр",
                    "TotalSum": 0.00,
                    "Quantity": 1.000,
                    "Price": 340.00,
                    "DiscountSum": 340.00
                }
            ],
            "ClientInformation": {
                "ID": 14995,
                "FirstName": "Наталия",
                "SecondName": "Кривошапко",
                "Surname": "Сергеевна",
                "Code2": "1CA15182-C731-4C60-BAB7-C684E22A109B",
                "TaxNum": "",
                "DateBirthday": "0001-01-01 00:00:00",
                "Phone": "380631234567,380631234567;380631234567",
                "Email": "",
                "Sex": 1
            }
        },
        {
            "TransactionID": 0,
            "DateTransaction": "",
            "BillID": 24008,
            "TransactionType": 0,
            "Sum": 620.00,
            "DiscountSum": 0.00,
            "ValuteISOCode": "UAH",
            "PayTypeName": "Кредитна карта",
            "PayTypeCode": "PAYMENT070314151426587",
            "CardID": 14996,
            "CardCode": "1111                                ",
            "TransactionItems": [
                {
                    "ItemID": 58690,
                    "TarifItemID": 58690,
                    "ArticleCode2": "31",
                    "ArticleName": "Салат с ростбифом 230гр",
                    "TotalSum": 260.00,
                    "Quantity": 1.000,
                    "Price": 260.00,
                    "DiscountSum": 0.00
                },
                {
                    "ItemID": 58689,
                    "TarifItemID": 58689,
                    "ArticleCode2": "75",
                    "ArticleName": "Тар-тар из телятины 220гр",
                    "TotalSum": 260.00,
                    "Quantity": 1.000,
                    "Price": 260.00,
                    "DiscountSum": 0.00
                },
                {
                    "ItemID": 58688,
                    "TarifItemID": 58688,
                    "ArticleCode2": "PRODUCT016910105238757",
                    "ArticleName": "Вино Albarino Paco&Lola б/с ",
                    "TotalSum": 100.00,
                    "Quantity": 1.000,
                    "Price": 100.00,
                    "DiscountSum": 0.00
                }
            ],
            "ClientInformation": {
                "ID": 14995,
                "FirstName": "Наталия",
                "SecondName": "Кривошапко",
                "Surname": "Сергеевна",
                "Code2": "1CA15182-C731-4C60-BAB7-C684E22A109B",
                "TaxNum": "",
                "DateBirthday": "0001-01-01 00:00:00",
                "Phone": "380631234567,380631234567;380631234567",
                "Email": "",
                "Sex": 1
            }
        },
        {
            "TransactionID": 0,
            "DateTransaction": "",
            "BillID": 24009,
            "TransactionType": 0,
            "Sum": 200.00,
            "DiscountSum": 105.00,
            "ValuteISOCode": "UAH",
            "PayTypeName": "Кредитна карта",
            "PayTypeCode": "PAYMENT070314151426587",
            "CardID": 14996,
            "CardCode": "1111                                ",
            "TransactionItems": [
                {
                    "ItemID": 58691,
                    "TarifItemID": 58691,
                    "ArticleCode2": "164",
                    "ArticleName": "Вино б/а Шардоне 150мл",
                    "TotalSum": 81.97,
                    "Quantity": 1.000,
                    "Price": 125.00,
                    "DiscountSum": 43.03
                },
                {
                    "ItemID": 58692,
                    "TarifItemID": 58692,
                    "ArticleCode2": "PRODUCT016926105239227",
                    "ArticleName": "Вино Игристое Perrier Jouet Belle Epoque Brut  ",
                    "TotalSum": 118.03,
                    "Quantity": 1.000,
                    "Price": 180.00,
                    "DiscountSum": 61.97
                }
            ],
            "ClientInformation": {
                "ID": 14995,
                "FirstName": "Наталия",
                "SecondName": "Кривошапко",
                "Surname": "Сергеевна",
                "Code2": "1CA15182-C731-4C60-BAB7-C684E22A109B",
                "TaxNum": "",
                "DateBirthday": "0001-01-01 00:00:00",
                "Phone": "380631234567,380631234567;380631234567",
                "Email": "",
                "Sex": 1
            }
        }
        }
    ]
}



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
Success Bool Успіх виконання запиту
LoyaltyTransactions LoyaltyTransactions[] Масив транзакцій. Елементи масиву структури з наступними полями:
     | TransactionID Int ID транзакції
     | DateTransaction Datetime Дата та час
     | BillID Int ID рахунку
     | TransactionType Int Тип транзакції
     | Sum Decimal Сума транзакції
     | DiscountSum Decimal Сума знижки (надбавки)
     | ValuteISOCode String Код валюти
     | PayTypeName String Найменування типу оплати
     | PayTypeCode String Код типу оплати
     | CardID Int ID карти
     | CardCode String Код карти
     | TransactionItems TransactionItems[] Масив позицій транзакції
     | |ItemID Int ID позиції транзакції
     | | TarifItemID Int ID тарифної позиції
     | | ArticleCode2 String Код2 номенклатури
     | | ArticleName String Назва номенклатури
     | | TotalSum Decimal Сума
     | | Quantity Decimal Кількість
     | | Price Decimal Ціна
     | | DiscountSum Decimal Сума знижки (надбавки)
     | ClientInformation ClientInformation[] Список даних клієнта
     | | ID Int ID клієнта
     | | FirstName String Ім'я клієнта
     | | SecondName String Прізвище
     | | Surname String По-батькові
     | | Code2 String Зовнішній код персони
     | | TaxNum String ІПН
     | | DateBirthday Datetime Дата народження
     | | Phone String Номер телефону
     | | Email String Електронна адреса
     | | Sex Int Стать (0 - чоловік, 1 - жінка)
Додатковий опис вхідних параметрів