Documentation / API / Operations on Users

GET and COUNT operations available on users.

Users Operations

GET

URL

POST https://your-secured-store-url:443/api/v1/users/get

Filters

Filter Type
id Array of GUID
firstname Array of String (max 255 chars)
lastname Array of String (max 255 chars)
email Array of String (max 255 chars)
phone Array of String (max 255 chars)
role Array of String (Predefined values)
language Array of String (Predefined values)
createdon_min DateTime
createdon_max DateTime

Request

Retrieve all the items (max 1000)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        }
    }

Retrieve specific items by ID

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id' : ['94ba74a8-614e-40aa-a4ae-1b267c8008fb','a6d0594a-d3e8-416e-a6b1-4a98ee91d98a']
        }
    }

Most complete request (just to give you the format of each parameter)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
		    'id' : ['94ba74a8-614e-40aa-a4ae-1b267c8008fb','a6d0594a-d3e8-416e-a6b1-4a98ee91d98a'],
		    'firstname' : ['Example'],
		    'lastname' : ['User','Admin'],
		    'email' : ['example@commerscale.com','example-admin@commerscale.com'],
		    'phone' : ['9901234567','4189876541'],
		    'role' : ['WEBSITE_USER','WEBSITE_ADMIN'],
		    'language' : ['fr-CA','en-US'],
		    'createdon_min' : '2015-01-01',
		    'createdon_max' : '2042-01-01'
        },
        'pagination' : {
            'pageNumber' : '1',
            'pageSize' : '1000'
        }
    }

Response

If no error occured, you will receive a response like this one (object type: User). Please refer to error messages to learn more about the possible error responses.

[
   {
      "id": "94ba74a8-614e-40aa-a4ae-1b267c8008fb",
      "firstname": "Example",
      "lastname": "User",
      "email": "example@commerscale.com",
      "phone": "9901234567",
      "role": "WEBSITE_USER",
      "language": "fr-CA",
      "createdon": "2016-02-03 15:43:52"
   },
   {
      "id": "a6d0594a-d3e8-416e-a6b1-4a98ee91d98a",
      "firstname": "Example",
      "lastname": "Admin",
      "email": "example-admin@commerscale.com",
      "phone": "4189876541",
      "role": "WEBSITE_ADMIN",
      "language": "fr-CA",
      "createdon": "2016-02-03 15:44:16"
   }
]

COUNT

URL

POST https://your-secured-store-url:443/api/v1/shipping/methods/count

Filters

Filter Type
id Array of GUID
firstname Array of String (max 255 chars)
lastname Array of String (max 255 chars)
email Array of String (max 255 chars)
phone Array of String (max 255 chars)
role Array of String (Predefined values)
language Array of String (Predefined values)
createdon_min DateTime
createdon_max DateTime

Request

Count the items

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        }
    }

Count specific items by role

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'role' : ['WEBSITE_USER']
        }
    }

Most complete request (just to give you the format of each parameter)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
		    'id' : ['94ba74a8-614e-40aa-a4ae-1b267c8008fb','a6d0594a-d3e8-416e-a6b1-4a98ee91d98a'],
		    'firstname' : ['Example'],
		    'lastname' : ['User','Admin'],
		    'email' : ['example@commerscale.com','example-admin@commerscale.com'],
		    'phone' : ['9901234567','4189876541'],
		    'role' : ['WEBSITE_USER','WEBSITE_ADMIN'],
		    'language' : ['fr-CA','en-US'],
		    'createdon_min' : '2015-01-01',
		    'createdon_max' : '2042-01-01'
        }
    }

Response

If no error occured, you will receive a response like this one. Please refer to error messages to learn more about the possible error responses.

{
   "count": "2"
}