Импорт пользователей

Доступно с версии 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": "ул. Пушкина, д. Колотушкина",
      "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) задано некорректно!"
                    }
                ]
            }
        ]
    }
}