- Пример информации о клиенте
| "user": { | Общая информация о клиенте |
| "phone": +71234567898, | Номер телефона |
| "gender": "MALE", | Пол |
| "uid": "b111111f-dd11-1f6d-b1a6-10f1e99da3453", | Идентификатор клиента в приложении |
| "avatar": https://thumbor.uds.app/unsafe/84x84/-, | Фотография |
| "participant": { | Информация о клиенте в этой компании |
| "cashbackRate": 10, | Размер кешбэка в процентах для данного пользователя в данной компании |
| "discountRate": 0.0, | Размер скидки (в процентах). |
| "id": 101111111111, | ID клиента в Вашей компании |
| "inviterId": 101111111112, | ID клиента , по рекомендации которого клиент вступил в компанию |
| "membershipTier": { | Настройки статусов клиентов |
| "conditions": { | Условия для автоматического назначения статуса |
| "effectiveInvitedCount": { | Условие по сумме покупок |
| "target": 5 }, | Количество эффективных рекомендаций |
| "totalCashSpent": { | Условие по сумме оплат |
| "target": 30000 } }, | Значение суммы по операциям |
| "name": "Базовый", | Название статуса клиента в компании |
| "rate": 10, | Коэффициент выполнения условий бонусной программы для автоматического повышения статуса |
| "uid": "base" }, | Идентификатор статуса |
| "points": 1000.00 , | Общее количество баллов у клиента |
| "displayName": "Sergey Uds", | Имя клиента |
| "code": "162111a1-9e39-4e7e-b60c-f30a2551"}, | Новый долгоживущий код на оплату, если был запрошен параметр exchangeCode |
| "purchase": { | Информация о текущей оплате |
| "cash": 900.00, | Сумма к оплате (в денежных единицах). |
| "discountAmount": 0.00, | Размер скидки (в денежных единицах). |
| "maxPoints": 100.00, | Максимальное количество накопленных бонусных баллов, доступных для списания (в денежных единицах). |
| "netDiscount": 100.00, | Общее количество доступных баллов для списания (в денежных единицах), включая оплату сертификатом. |
| "points": 100.00, | Количество бонусных баллов (в денежных единицах). |
| "netDiscountPercent": 10.00, | Общий размер скидки (в процентах от общей суммы счета). |
| "cashBack": 80.00, | Вознаграждение (кешбэк), которое получит клиент после проведения операции (в бонусных баллах). |
| "total": 1000.00, | Общая сумма счета (в денежных единицах). |
| "skipLoyaltyTotal": 100, | Сумма, на которую не должна применяться скидка или начисляться кешбэк (в денежных единицах). |
| "pointsPercent": 10.00, | Размер скидки за счет бонусных баллов (в процентах) |
| "discountPercent": 0 } |
Предоставленная скидка (в процентах) |
- Пример информации о компании
| "id": 549755973, | Идентификатор компании. |
| "name": "Новая компания", | Название компании. |
| "promoCode": "promocode", | Промокод компании для вступления. |
| "baseDiscountPolicy": "CHARGE_SCORES", | Тип программы лояльности: APPLY_DISCOUNT - понижать сумму счета (скидка); CHARGE_SCORES - начислять бонусные баллы (кешбэк). |
| "purchaseByPhone": true, | Возможность проведения операции, используя номер телефона клиента. |
| "writeInvoice": false, | Необходимо указывать номер счета при проведении оплаты через UDS Кассир |
| "currency": "RUB", | Валюта компании (стандарт ISO-4217). |
| "loyaltyProgramSettings": { | Настройки бонусной программы компании. |
| "baseMembershipTier": { | Настройки базового статуса клиентов. |
| "uid": "base", | Идентификатор статуса. |
| "name": "Базовый", | Название статуса. |
| "conditions": { | Условия для автоматического назначения статуса. |
| "totalCashSpent": null }, | Повысить статус, когда сумма покупок достигнет данного значения. |
| "rate": 10 }, | Процент скидки / начисления бонусных баллов |
| "membershipTiers": [ { | Настройки статусов клиентов. |
| "uid": "d98c3449-b15d-41c8-8917-4b8e1", | Идентификатор статуса. |
| "name": "Вип", | Название статуса. |
| "conditions": { | Условия для автоматического назначения статуса. |
| "totalCashSpent": { | Повысить статус, когда сумма покупок достигнет данного значения. |
| "target": 10000} }, | Сумма покупок |
| "effectiveInvitedCount": { | Повысить статус, когда количество рекоендаций достигнет данного значения. |
| "target": 10} }, | Количество рекомендаций |
| "rate": 20 } ], | Процент скидки / начисления бонусных баллов |
| "deferPointsForDays": null, | Количество дней, после которых будут начислены отложенные бонусные баллы. |
| "referralCashbackRates": [ | Коэффициенты начисления кешбэка для рефералов (3 уровня в %). |
| 8, | 1 уровень |
| 1, | 2 уровень |
| 1 ], | 3 уровень |
| "receiptLimit": null, | Максимальная сумма операции, которую можно провести через UDS Кассир |
| "cashierAward": 1, | Вознаграждение кассира за проведенную операцию |
| "referralReward": 10, | Вознаграждение клиенту за эффективную рекомендацию |
| "maxScoresDiscount": 100 }, | Процент счета, который можно оплатить бонусными баллами. |
| "slug": "support" } | Доменное имя, которое отражается в ссылке на веб-страницу вашей компании. |
- Пример ответа на запрос при проведении оплаты
| "id": 126013152, | Id операции в базе UDS |
| "dateCreated": "2020-01-24T11:24:12.707Z", | Дата операции |
| "action": "PURCHASE", | Тип операции |
| "state": "NORMAL", | Статус |
| "customer": { | Информация о клиенте |
| "id": 1011111111111, | Идентификатор клиента в компании |
| "uid": "aa11d111-d111-1cce-bb1b-e10efcab74a5", | Идентификатор клиента в приложении |
| "displayName": "Support UDS", | Имя и фамилия клиента |
| "membershipTier": { | Настройки статусов клиентов |
| "uid": "1f1a111f-11fb-1cf1-bebe-1111dab1111d", | Идентификатор статуса |
| "name": "Серебряный", | Название статуса |
| "conditions": { | Условия для автоматического назначения статуса |
| "totalCashSpent": { | Условие по сумме покупок |
| "target": 30000 } , | Сумма по операциям |
| "effectiveInvitedCount":{ | Условие по количеству эффективных рекомендаций |
| "target": 5 } , | Количество эффективных рекомендаций |
| "rate": 60 } }, | Коэффициент выполнения условий бонусной программы для автоматического повышения статуса |
| "cashier": { | Информация о сотруднике |
| "id": 274878296913, | Идентификатор сотрудника |
| "displayName": "Иванов Иван" }, | Имя сотрудника |
| "branch":{ | Информация о филиале |
| "id":"2435" | id филиала |
| "displayName": "Москва" }, | Наименование филиала |
| "points": 0, | Количество списываемых баллов |
| "cash": 1000, | Сумма, оплачиваемая деньгами |
| "total": 1000, | Сумма чека |
| "receiptNumber": "1234554321" }, | Номер чека |
| "origin": { | Для сторнирующей операции - ссылка на оригинальную операцию(для операции возврата) |
| "id": "100" } | Идентификатор исходной операции |
- Пример информации о товаре
| "name": "Apple", | Название товара |
| "nodeId": 11223344, | ID категории |
| "externalId": "apple", | Внешний идентификатор |
| "photos": ["iefiejrgw"], | Список идентификаторов изображений |
| "imageUrls": "https://uds.app/photo/id/iefiejrgw", | Список ссылок на изображения |
| "hidden": false, | Скрыт ли товар |
| "blocked": false, | Заблокирован ли товар |
| "data": { | |
| "type": "VARYING_ITEM", | Тип товара |
| "description": "This is an item without category" | Описание товара |
| "variants": [ { | Список вариантов |
| "name": "red apple", | Название первого варианта |
| "sku": "111", | Артикул первого варианта |
| "price": 110.0}, { | Цена первого варианта |
| "name": "green apple", | Название второго варианта |
| "sku": "222", | Артикул второго варианта |
| "price": 160.0 } ] | Цена второго варианта |
- Пример информации о заказе
|
"id": 1122211, |
Номер заказа |
|
"dateCreated": "2020-07-16T14:31:47Z", |
Дата заказа |
|
"comment": "Мой комментарий", |
Комментарий к заказу |
|
"state": "NEW", |
Статус заказа |
|
"cash": 900, |
Сумма, оплачиваемая деньгами |
|
"points": 100, |
Количество списываемых баллов |
|
"total": 1000, |
Сумма заказа |
|
"customer": { |
Информация о клиенте |
|
"id": 10111111111, |
ID клиента в компании |
|
"displayName": "Support UDS", |
Имя клиента |
|
"uid": "aa11d111-d111-1cce-bb1b-e10efcab74a5", |
Идентификатор клиента в приложении |
|
"membershipTier": { |
Настройки статусов клиентов |
|
"uid": "1f1a111f-11fb-1cf1-bebe-1111dab1111d", |
Идентификатор статуса |
|
"name": "Серебряный", |
Название статуса |
|
"conditions": { |
Условия для автоматического назначения статуса |
|
"totalCashSpent": { |
Условие по сумме покупок |
|
"target": 30000 } , |
Сумма по операциям |
|
"effectiveInvitedCount":{ |
Условие по количеству эффективных рекомендаций |
|
"target": 5 } , |
Количество эффективных рекомендаций |
| "rate": 60 } }, | Коэффициент выполнения условий бонусной программы для автоматического повышения статуса |
|
"delivery": { |
Информация о способе получения заказа |
|
"receiverName": "Sergey UDS", |
Информация о клиенте, который заберет заказ |
|
"receiverPhone": "+791234567898", |
Номер телефона клиента |
|
"userComment": "Комментарии клиента", |
Комментарий от клиента к заказу |
|
"branch":{ |
Информация о филиале |
|
"id": "12111" |
ID филиала |
|
"displayName": "Москва" }, |
Наименование филиала |
|
"type": "PICKUP" }, |
Способ получения заказа |
|
"onlinePayment": { |
Информация об онлайн-оплате заказа |
|
"paymentProvider": "Cloudpayments", |
Тип платежной системы |
|
"id": "string", |
Идентификатор платежа в платежной системе |
|
"completed": true}, |
Статус платежа |
|
"items": [ { |
Информация о товарах в заказе |
|
"id": 121244, |
ID товара |
|
"externalId": "apple", |
Внешний идентификатор товара |
|
"name": "Apple", |
Название товара |
|
"variantName": "Red apple", |
Название варианта товара |
|
"sku": "111", |
Артикул товара |
|
"type": "ITEM", |
Тип товара |
|
"qty": 2 } ] |
Количество товара |