Вы можете связать вашу учетную систему с платформой и получать данные о картах из платформы. Обычно это 1С Управление торговлей.
Список бонусных карт
Получает список бонусных карт. Список можно фильтровать и производить поиск.
Путь: /wp-json/usam/v1/bonus/cards
Метод запроса: GET
- search (строка) (не обязательно) — поиск по номеру, по телефону или электронной почте;
- search_columns (строка или массив строк) (не обязательно) — указать названия поля для поиск;
- status (строка) (не обязательно) — код статуса;
- count (число) (не обязательно) — количество, по умолчанию 10;
- paged (число) (не обязательно) — страница списка;
Для параметра search_columns доступны значения:
- code — искать по коду карты,
- user_login — искать по номеру пользователя,
- email — искать по почте,
- phone — искать по номеру телефона,
- customer_name — искать по имени пользователя
Возвращает
Ответы в формате JSON
{"count":"3037","items":[{"code":"398386","status":"active","user_id":"2165","sum":"0","percent":"0.00","date_insert":"2020-10-01 12:18:41"},{"code":"776563","status":"active","user_id":"2887","sum":"0","percent":"0.00","date_insert":"2021-07-19 13:05:54"},{"code":"800294","status":"active","user_id":"1948","sum":"0","percent":"0.00","date_insert":"2020-07-23 11:46:01"},{"code":"839552","status":"active","user_id":"2452","sum":"0","percent":"0.00","date_insert":"2021-02-01 12:15:06"},{"code":"2310438","status":"active","user_id":"2389","sum":"0","percent":"0.00","date_insert":"2021-02-01 12:14:00"},{"code":"2711337","status":"active","user_id":"2013","sum":"36","percent":"0.00","date_insert":"2020-07-06 14:24:31"},{"code":"2838398","status":"active","user_id":"2189","sum":"61","percent":"0.00","date_insert":"2020-08-14 15:15:49"},{"code":"4373169","status":"active","user_id":"2642","sum":"500","percent":"0.00","date_insert":"2021-03-05 15:46:39"},{"code":"5257693","status":"active","user_id":"2647","sum":"0","percent":"0.00","date_insert":"2021-03-31 14:41:10"},{"code":"5315965","status":"active","user_id":"2683","sum":"370","percent":"0.00","date_insert":"2021-03-25 09:25:31"}]}
- count — всего карт;
- items — массив с данными карт;
содержание элемента items:
- code — код карты;
- status — статуса;
- user_id — номер пользователя;
- sum — сумма бонусов на карте, доступных для списания(оплаты);
- percent — процент по карте;
- date_insert — дата создания карты;
Бонусная карта
Получает данные указанной бонусной карты, например, получить данные 999889162 карты /wp-json/usam/v1/bonus/card/999889162
Путь: /wp-json/usam/v1/bonus/card/(номер)
Метод запроса: GET
Пример запроса
/wp-json/usam/v1/bonus/card/999889162
Возвращает
Ответы в формате JSON
{"code":"999889162","status":"active","user_id":"2497","sum":"500","percent":"0.00","date_insert":"2021-01-17 21:11:07"}
Описание возвращаемых параметров
- code — код карты;
- status — статуса;
- user_id — номер пользователя;
- sum — сумма бонусов на карте, доступных для списания(оплаты);
- percent — процент по карте;
- date_insert — дата создания карты;
Транзакция по бонусной карте
Записывает транзакцию по бонусной карте
Путь: /wp-json/usam/v1/bonus/transaction/(номер)
Метод запроса: POST
- type_transaction (число) (не обязательно) — тип транзакции. 0 бонусы добавляются на карту, 1 бонусы списываются с карты при оплате (обязательный);
- bonus (число) (не обязательно) — количество бонусов (обязательный);
- description (строка) (не обязательно) — описание причины транзакции (обязательный);
Пример запроса
/wp-json/usam/v1/bonus/transaction/999889162
{"type_transaction":0,"bonus":68,"description":"Оплата заказа №45"}
Возвращает
Возвращает номер карты если карта создана.
999889162