Export of active users

Function users/export (http://<DOMAIN>/api/users/export/)

Parameters:

• token - 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 - 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 - all users who registered before 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
• Starting with version 3.30
• offset - 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 - 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)

For 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/):

{
    "token" : "<YOUR TOKEN>",
    "from" : "21.11.2016", 
    "to" : "22.11.2016"
}

Example of a response to a query:

{
    "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"
            }
        ]
    }
}