Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Функция users/export (http://<DOMAIN>/api/users/export/)

Параметры:

  • token - ключ авторизации полученный через функцию auth

  • from - выгрузка пользователей начиная с даты регистрации (например 01.02.2015 14:15:00 - будут выгружены все пользователи которые зарегистрировались с первого февраля 2015 года после 14:15) - не обязательный параметр.
    Формат:
    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии 3.30
    • YYYY-MM-DD HH:mm:ss
    • DD.MM.YYYY HH:mm:ss
  • to - выгрузка пользователей которые зарегистрировались до указанной даты (например 01.02.2015 - будут выгружены все пользователи которые зарегистрировались до первого февраля 2015 года) - не обязательный параметр.
    Формат:
    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии 3.30
    • YYYY-MM-DD HH:mm:ss
    • DD.MM.YYYY HH:mm:ss
  • Начиная с версии 3.30
  • offset - смещение относительно начала выборки пользователей (работает только в паре с параметром limit)
  • limit - количество выводимых пользователей

Ответ:

  • status - статус выполнения функции

    • OK - курсы валют были успешно выгружены

    • EMPTY - запрос не дал результатов

  • response.users[] - список пользователей

    • response.users[i].id - идентификатор пользователя в системе

    • response.users[i].title - Имя пользователя
    • response.users[i].email - Email пользователя
    • response.users[i].phone - Номер телефона пользователя
    • response.users[i].country - Страна доставки пользователя (не пустое если на сайте включена доставка по странам)
    • response.users[i].city - Город доставки пользователя
    • response.users[i].address - Адрес доставки пользователя
    • response.users[i].registered - Дата регистрации пользователя (Формат ГГГГ-ММ-ДД ЧЧ:ММ:СС, напр. 2016-01-13 12:52:34)


Для Хорошоп b2b

  • response.users[i].customer_group_id - группа покупателей, присвоенная пользователю
  • response.users[i].balance - баланс пользователя
  • response.users[i].manager - менеджер магазина, закрепленный за пользователем
    • response.users[i].manager.id - идентификатор менеджера
    • response.users[i].manager.name - имя менеджера
    • response.users[i].manager.phone - номер телефона менеджера
  • response.users[i].site_link - ссылка на сайт пользователя
  • response.users[i].company - ссылка на сайт компании пользователя
  • response.users[i].role- должность пользователя в компании



Пример запроса на адрес (http://<DOMAIN>/api/users/export/):

JSON
{
    "token" : "<ВАШ ТОКЕН>",
    "from" : "21.11.2016", 
    "to" : "22.11.2016"
}


Пример ответа на запрос:

JSON
{
    "status": "OK",
    "response": {
        "users": [
            {
                "id": 176,
                "title": "Иванов Иван",
                "email": "test@gmail.com",
                "phone": "+38 (055) 555-55-55",
                "country": "Украина",
                "city": "Киев",
                "address": "",
                "registered": "2021-05-13 19:41:17",
                "customer_group_id": 1,
                "balance": "0.00",
                "balance_currency": "1",
                "manager": "Николай",
                "site_link": "test.com",
                "company": "Test Company",
                "role": "customer"
            }
        ]
    }
}


  • No labels