Versions Compared

Key

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

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

ПараметрыParameters:

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

    from - выгрузка пользователей начиная с даты регистрации (например

     authorization key obtained through the auth function

  • from - downloading of users who registered after the specified date (e.g. 01.02.2015 14:15:00 - будут выгружены все пользователи которые зарегистрировались с первого февраля 2015 года после 14:15) - не обязательный параметр.
    Форматall users who registered starting from 14:15 February 1, 2015, will be downloaded) - optional parameter.
    Format:
    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии Starting with version 3.30
    • YYYY-MM-DD HH:mm:ss
    • DD.MM.YYYY HH:mm:ss
  • to -   выгрузка пользователей которые зарегистрировались до указанной даты (например downloading users who registered before the specified date (e.g. 01.02.2015 - будут выгружены все пользователи которые зарегистрировались до первого февраля 2015 года) - не обязательный параметр.
    Форматall users who registered before February 1, 2015 will be downloaded) - optional parameter.
    Format:
    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии Starting with version 3.3030
    • YYYY-MM-DD HH:mm:ss
    • DD.MM.YYYY HH:mm:ss
  • Начиная с версии Starting with version 3.3030
  • offset - смещение относительно начала выборки пользователей (работает только в паре с параметром limit offset of user selection relative to the start (works only in combination with the limit parameter)
  • limit - количество выводимых пользователей

...

  •  number of users displayed

Response:

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

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

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

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

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

    • response.users[i].title - Имя пользователяuser name
    • response.users[i].email -Email пользователя user email
    • response.users[i].phone - Номер телефона пользователяuser phone number
    • response.users[i].country - Страна доставки пользователя (не пустое если на сайте включена доставка по странамuser's delivery country (not blank if the site has country selection at checkout enabled)
    • response.users[i].city - Город доставки пользователя user's delivery city 
    • response.users[i].address - Адрес доставки пользователяuser's delivery address 
    • response.users[i].registered - Дата регистрации пользователя (Формат ГГГГ-ММ-ДД ЧЧ:ММ:СС, напрuser registration date (Format YYYYY-MM-DD HH:MM:SS, e.g. 2016-01-13 12:52:34)


Для Хорошоп b2bFor Cartum B2B:

  • response.users[i].customer_group_id - группа покупателей, присвоенная пользователюcustomer group assigned to the user
  • response.users[i].balance - баланс пользователяuser balance
  • response.users[i].manager - менеджер магазина, закрепленный за пользователемstore manager assigned to the user
    • response.users[i].manager.id - идентификатор менеджераmanager ID
    • response.users[i].manager.name - имя менеджераmanager name
    • response.users[i].manager.phone - номер телефона менеджераmanager's phone number
  • response.users[i].site_link - ссылка на сайт пользователяlink to the user's website
  • response.users[i].company - ссылка на сайт компании пользователяlink to the user's company website
  • response.users[i].role - должность пользователя в компании

...

  • user position in the company



Example of a query to address (http://<DOMAIN>/api/users/export/):

Code Block
languagejs
titleJSON
{
    "token" : "<ВАШ<YOUR ТОКЕН>TOKEN>",
    "from" : "21.11.2016", 
    "to" : "22.11.2016"
}


Пример ответа на запросExample of a response to a query:

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

...