Імпорт користувачів

Доступно з версії 3.23.0


Функція users/import

Параметри запиту

  • token - ключ авторизації, отриманий через функцію auth
  • users - список імпортованих користувачів
    • users[i].title - ПІБ користувача (обов'язкове поле)
    • users[i].email - Email користувача (обов'язкове, унікальне поле)
    • users[i].phone - Номер телефону (з кодом країни)
    • users[i].country - Країна доставки користувача за замовчуванням (не використовується, якщо вимкнена функція вибору країн у замовленні)
    • users[i].city - Місто доставки користувача за замовчуванням
    • users[i].address - Адреса доставки користувача за замовчуванням
    • users[i].discount_card - Персональна знижка користувача
      • users[i].discount_card.discount - розмір знижки (%)
      • users[i].discount_card.active - увімкнення/вимкнення персональної знижки
      • users[i].discount_card.date_limit - термін дії знижки (Формат РРРР-ММ-ДД)
      • users[i].discount_card.status - статус знижки
        • 1 - підтверджена
        • 2 - очікує на підтвердження
        • 3 - відхилена


Нові параметри для Хорошоп b2b з версії 4.0

  • users[i].customer_group_id - id групи покупців, до якої належить користувач
  • users[i].balance - сума балансу користувача, може бути від'ємною
  • users[i].balance_currency - валюта балансу користувача
  • users[i].manager_id- id менеджера магазину, закріпленого за користувачем
  • users[i].site_link - рядок, посилання на сайт користувача
  • users[i].company - рядок, назва компанії користувача
  • users[i].role - рядок, посада користувача в компанії


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

  • status - Статус виконання запиту
    • OK - Усіх користувачів запиту було успішно додано/оновлено
    • WARNING - Деякі користувачі не були додані/оновлені
  • response.log - Журнал оновлення
    • response.log[i].code - Код повідомлень (див. таблицю нижче)
    • response.log[i].message - Розшифровка повідомлення


Коди повідомлень журналу

КодЗначення
0Користувача було успішно імпортовано/оновлено
1Пропущені обовʼязкові поля
2Помилка валідації полів
3Необроблена помилка

Приклад запиту

POST http://<DOMAIN>/api/users/import/
Content-Type: application/json

{
  "token": "<TOKEN>",
  "users": [
    {
      "title": "Свириденко Петро Олександрович",
      "email": "ivan@mail.net",
      "phone": "+380631234567",
      "country": "Україна",
      "city": "Київ",
      "address": "вул.Сагайдачного, д. 16",
      "discount_card": {
        "discount": 3,
        "active": true,
        "date_limit": "2019-01-01",
        "status": 1
      }
    },
    {
      "title": "Свириденко Олена Олегівна",
      "email": "elena@mail.net",
      "phone": "+380631234567",
      "country": "Україна",
      "city": "Київ",
      "address": "вул. Хрещатик, д. 1",
      "discount_card": {
        "discount": 3,
        "active": true,
        "date_limit": "2020-01-01",
        "status": 1
      }
    },
    {
        "email": "some@email"
    }
  ]
}

Приклад запиту

{
    "status": "WARNING",
    "response": {
        "log": [
            {
                "info": [
                    {
                        "code": 0,
                        "message": "Обновление пользователя ivan@mail.net завершено успешно!"
                    }
                ]
            },
            {
                "info": [
                    {
                        "code": 0,
                        "message": "Обновление пользователя elena@mail.net завершено успешно!"
                    }
                ]
            },
            {
                "info": [
                    {
                        "code": 1,
                        "message": "Поле email (some@email) задано некорректно!"
                    }
                ]
            }
        ]
    }
}