Rest API Клієнти програми лояльності - datawizio/pythonAPI GitHub Wiki

37. Ресурс /get_loyalty_customer/ POST

Клієнти програми лояльності. З допомогою ресурсу /get_loyalty_customer/ можна отримати дані по клієнтах програми лояльності, відфільтрувати по даті, магазинах і т.д.

37.1. POST-параметри:

Назва поля Тип поля Доступні значення Значення за замовчуванням Опис
format рядок "json", "api" "json" Формат відповіді сервера
shops число, список - Всі магазини Ідентифікатор чи список ідентифікаторів магазинів
date_from рядок - Дата останньої підгрузки клієнта - 30 днів Початкова дата вибірки
date_to рядок - Дата останньої підгрузки клієнта Кінцева дата вибірки
loyalty_id число, список - Всі клиенти Ідентифікатор чи список ідентифікаторів клієнта програми лояльності
type рядок "cardno", "name", "loyalty_id" "loyalty_id" Ідентифікація клієнта програми лояльності

37.1.2. Параметри відповіді:

Назва поля Тип поля Обов'язкова наявність у відповіді Опис
loyalty_id число ні Ідентифікатор клієнта програми лояльності
cardno рядок ні Номер карти клієнта програми лояльності
name рядок ні Ім'я клієнта програми лояльності
last_visit рядок так Дата останнього відвідування
number_visits число так Загальна к-сть відвідувань клієнта програми лояльності
spend число так Загальний оборот клієнта програми лояльності
Магазин №1 число так Оборот клієнта програми лояльності по магазину "Магазин №1"
Магазин №... число ні Оборот клієнта програми лояльності по магазину "Магазин №..."
Магазин №N число ні Оборот клієнта програми лояльності по магазину "Магазин №N"

37.2. Приклад роботи з ресурсом

Команда: POST http://api.datawiz.io/api/v1/get_loyalty_customer/

Суфікси (аналог параметру format):
  • .json - отримати відповідь з сервера в форматі JSON
  • .api - отримати відповідь з сервера в форматі HTML (тестова платформа)
Приклад POST-параметрів:
{
  "date_from": "2018-01-01",
  "date_to": "2018-01-15",
  "shops": [674, 541],
  "type": "cardno"
}
Відповідь сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "result": [
    {
      "last_visit": "2018-01-03",
      "cardno": "1212525",
      "Shop №1": 2,
      "Shop №2": 1,
      "spend": 56.23,
      "number_visits": 3
    },
    {
      "last_visit": "2018-01-05",
      "cardno": "1220710",
      "Shop №1": 1,
      "Shop №2": 0,
      "spend": 65.23,
      "number_visits": 1
    },
    ...
    {
      "last_visit": "2018-01-15",
      "cardno": "1205646",
      "Shop №1": 0,
      "Shop №2": 3,
      "spend": 123.79,
      "number_visits": 3
    },
    {
      "last_visit": "2018-01-15",
      "cardno": "1206491",
      "Shop №1": 1,
      "Shop №2": 1,
      "spend": 35.78,
      "number_visits": 2
    }
  ]
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️