POST /retail

Проведение продажи в БонусПлюс

Запрос

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

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

Номер телефона клиентов

string

Да

items

Позиции чека

Массив RetailItem

Да

bonusDebit

Сумма бонусов, которую требуется списать для чека

decimal

Да

externalId

Идентификатор чека во внешней системе

string
tags

Таги

Массив int
desc

Примечание

string
date

Дата проведения продажи

string
store

Магазин

string
coupons

Купоны, применяемые к чеку

Массив string
certificate

Магазин

bool

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

application/json, text/json

Sample:
{
  "phone": "sample string 1",
  "items": [
    {
      "sum": 1.0,
      "qnt": 2.0,
      "product": "sample string 3",
      "ds": 4.0,
      "cat": "sample string 5",
      "ext": "sample string 6",
      "price": 1.0,
      "sellMode": "sample string 7"
    },
    {
      "sum": 1.0,
      "qnt": 2.0,
      "product": "sample string 3",
      "ds": 4.0,
      "cat": "sample string 5",
      "ext": "sample string 6",
      "price": 1.0,
      "sellMode": "sample string 7"
    }
  ],
  "bonusDebit": 2.0,
  "externalId": "sample string 3",
  "tags": [
    1,
    2
  ],
  "desc": "sample string 4",
  "date": "sample string 5",
  "store": "sample string 6",
  "coupons": [
    "sample string 1",
    "sample string 2"
  ],
  "certificate": true
}

Ответ

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

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

Идентификатор продажи в БонусПлюс

int

Да

orderUid

Идентификатор продажи в БонусПлюс

GUID
orderUrl

Ссылка на чек

string
customer

Клиент

Customer

Да

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

application/json, text/json

Sample:
{
  "id": 1,
  "orderUid": "7bb6e92d-fac0-4356-a4ad-fbe43ad60512",
  "orderUrl": "sample string 3",
  "customer": {
    "multiplicityDebitBonus": 1.0,
    "phone": "sample string 1",
    "id": "207f679d-08bf-4a52-a668-612c6f6de357",
    "discountCardTypeId": 3,
    "discountCardNumber": "sample string 4",
    "discountCardName": "sample string 5",
    "parentphone": "sample string 6",
    "availableBonuses": 7.0,
    "notActiveBonuses": 8.0,
    "lastPurchaseDate": "2024-04-20T03:22:43.3756777+03:00",
    "person": {
      "fn": "sample string 1",
      "ln": "sample string 2",
      "mn": "sample string 3",
      "sex": "Female",
      "email": "sample string 4",
      "desc": "sample string 5",
      "birthDay": "sample string 6",
      "profileInstagram": "sample string 7",
      "profileVkontakte": "sample string 8",
      "profileOdnoklassniki": "sample string 9",
      "address": "sample string 10",
      "utmSource": "sample string 11",
      "creationDate": "2024-04-20T03:22:43.3756777+03:00",
      "lastUpdateDate": "2024-04-20T03:22:43.3756777+03:00",
      "createdInStore": "sample string 13",
      "disablePromoSMS": true,
      "relatives": [
        {
          "birthDay": "sample string 1",
          "sex": "Female"
        },
        {
          "birthDay": "sample string 1",
          "sex": "Female"
        }
      ],
      "createdInStoreId": 1,
      "createdByCashierId": 1
    },
    "purchasesTotalSum": 9.0,
    "purchasesSumToNextCard": 10.0,
    "nextCardName": "sample string 11",
    "regressEnabled": true,
    "bonusDebitDenided": true,
    "nearestBonusesExpirationAmount": 14.0,
    "avgPurchasesTotal": 15.0,
    "nearestBonusesExpirationDate": "sample string 16",
    "purchasesCount": 17,
    "confirmed": true,
    "inviteCode": "sample string 19",
    "registrationSourceId": "sample string 20",
    "baseDiscountPercent": 21.0,
    "baseBonusDebitPercent": 22.0,
    "baseBonusCreditPercent": 23.0,
    "telegramBotStatus": 24,
    "telegramBotRegistrationDate": "2024-04-20T03:22:43.3756777+03:00",
    "eCardStatusID": 1,
    "vkStatusID": 1,
    "disableAllMessages": true,
    "isBlocked": true
  }
}