Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Доступно с версии
Info
iconfalse
Доступно з версії 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 -
        отклонена
        • відхилена


Новые параметры
Info
iconfalse

Нові параметри для Хорошоп 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Необроблена помилка


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

Пример запроса
Code Block
title
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"
    }
  ]
}


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

Пример ответа
Code Block
title
{
    "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) задано некорректно!"
                    }
                ]
            }
        ]
    }
}

...