POST /retail/transactions

Возвращает список транзакций по заданному фильтру. Максимальное количество возвращаемых транзакций за один запрос - 1000 (задается в параметрах фильтра)

Запрос

Фильтр для поиска

Тело запроса (объект TransactionFilter )

ПолеОписаниеТипОбязательное
creationDate

Интервалы дат операций

Массив DateTimeInterval
phone

Телефоны клиентов

Массив string
card

Список карт (статусов)

Массив int
cashier

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

Массив int
cardNumber

Номера карт

Массив string
store

Список магазинов

Массив int
person

Идентификаторы клиентов

Массив int
externalId

Внешний идентификатор

string
startRow

Начальный номер строки для выборки. Используется для пейджинга

int
rowCount

Количество строк (максимум 1000). Используется для пейджинга

int
sort

int
purchaseNumber

int
purchaseNumbers

Массив int

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

application/json, text/json

Sample:
{
  "creationDate": [
    {
      "from": "2024-04-26T12:15:04.2659347+03:00",
      "to": "2024-04-26T12:15:04.2659347+03:00"
    },
    {
      "from": "2024-04-26T12:15:04.2659347+03:00",
      "to": "2024-04-26T12:15:04.2659347+03:00"
    }
  ],
  "phone": [
    "sample string 1",
    "sample string 2"
  ],
  "card": [
    1,
    2
  ],
  "cashier": [
    1,
    2
  ],
  "cardNumber": [
    "sample string 1",
    "sample string 2"
  ],
  "store": [
    1,
    2
  ],
  "person": [
    1,
    2
  ],
  "externalId": "sample string 1",
  "startRow": 2,
  "rowCount": 3,
  "sort": 4,
  "purchaseNumber": 1,
  "purchaseNumbers": [
    1,
    2
  ]
}

Ответ

Тело ответа ( объект TransactionList )

ПолеОписаниеТипОбязательное
transactions

Транзакции

Массив Transaction
showExternalPurchaseNumber

bool
receiptCount

Количество чеков

int
receiptSum

Сумма чеков

decimal
bonusCreditSum

Сумма начисленных бонусов

decimal
bonusDebitSum

Сумма списанных бонусов

decimal
receiptReturnCount

Количество возвратов

int
receiptReturnSum

Сумма возвратов

decimal
burnBonusCount

Количество операций сгорания бонусов

int
burnBonusSum

Сумма сгоревших бонусов

decimal
birthdayBonusCount

Количество операций поздравления с днем рождения

int
birthdayBonusSum

Сумма бонусов, подаренных на день рождения

decimal
reanimationBonusCount

Количество операций "реанимации" клиентов

int
reanimationBonusSum

Сумма бонусов, выданных по процедуре "реанимация клиентов"

decimal
manualCreditBonusCount

Количество операций ручного начисления бонусов

int
manualCreditBonusSum

Сумма бонусов, начисленных вручную

decimal

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

application/json, text/json

Sample:
{
  "transactions": [
    {
      "externalPurchaseNumber": 1,
      "type": 1,
      "externalId": "sample string 2",
      "positionId": 1,
      "typeName": "sample string 3",
      "product": "sample string 4",
      "productName": "sample string 5",
      "remainAmount": 6.0,
      "benefitInfo": "sample string 7",
      "productCategory": "sample string 8",
      "quantity": 1.0,
      "saleId": 1,
      "date": "2024-04-26T12:15:04.281556+03:00",
      "purchaseAmount": 1.0,
      "payment": -1.0,
      "discountAmount": 1.0,
      "bonusCredit": 1.0,
      "bonusDebit": 1.0,
      "cardName": "sample string 10",
      "storeId": 1,
      "storeName": "sample string 11",
      "storeAddress": "sample string 12",
      "cashierId": 1,
      "cashierName": "sample string 13",
      "phoneNumber": "sample string 14",
      "cardNumber": 1,
      "tags": "sample string 15",
      "customerFirstName": "sample string 16",
      "customerLastName": "sample string 17",
      "customerMiddleName": "sample string 18"
    },
    {
      "externalPurchaseNumber": 1,
      "type": 1,
      "externalId": "sample string 2",
      "positionId": 1,
      "typeName": "sample string 3",
      "product": "sample string 4",
      "productName": "sample string 5",
      "remainAmount": 6.0,
      "benefitInfo": "sample string 7",
      "productCategory": "sample string 8",
      "quantity": 1.0,
      "saleId": 1,
      "date": "2024-04-26T12:15:04.281556+03:00",
      "purchaseAmount": 1.0,
      "payment": -1.0,
      "discountAmount": 1.0,
      "bonusCredit": 1.0,
      "bonusDebit": 1.0,
      "cardName": "sample string 10",
      "storeId": 1,
      "storeName": "sample string 11",
      "storeAddress": "sample string 12",
      "cashierId": 1,
      "cashierName": "sample string 13",
      "phoneNumber": "sample string 14",
      "cardNumber": 1,
      "tags": "sample string 15",
      "customerFirstName": "sample string 16",
      "customerLastName": "sample string 17",
      "customerMiddleName": "sample string 18"
    }
  ],
  "showExternalPurchaseNumber": true,
  "receiptCount": 1,
  "receiptSum": 1.0,
  "bonusCreditSum": 1.0,
  "bonusDebitSum": 1.0,
  "receiptReturnCount": 1,
  "receiptReturnSum": 1.0,
  "burnBonusCount": 1,
  "burnBonusSum": 1.0,
  "birthdayBonusCount": 1,
  "birthdayBonusSum": 1.0,
  "reanimationBonusCount": 1,
  "reanimationBonusSum": 1.0,
  "manualCreditBonusCount": 1,
  "manualCreditBonusSum": 1.0
}