Documentation / API / Operations on Domains

GET and COUNT operations available on domains.

Domains Operations

GET

URL

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

Filters

Filter Type
id Array of GUID
url Array of String (max 255 chars)
redirecturl Array of String (max 255 chars)
dnsconfigured Boolean
resale Boolean
default Boolean
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' : ['00000000-0000-0000-0000-000000000000', '12345678-1234-1234-1234-123456781234']
        }
    }

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

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id': ['00000000-0000-0000-0000-000000000000', '12345678-1234-1234-1234-123456781234'],
            'url' : ['mystore1.commerscale.com','mystore2.commerscale.com'],
		    'redirecturl' : ['mystore1.commerscale.com','mystore2.commerscale.com'],
		    'dnsconfigured' : 'false',
		    'resale' : 'false',
		    'default' : 'false',
		    '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: Domain). Please refer to error messages to learn more about the possible error responses.

[
   {
      "id": "00000000-0000-0000-0000-000000000000",
      "url": "mystore1.commerscale.com",
      "redirecturl": "mystore1.commerscale.com",
      "dnsconfigured": "false",
      "resale": "false",
      "default": "false",
      "author": "Mr Example",
      "createdon": "2016-01-06 15:15:01"
   },
    {
      "id": "12345678-1234-1234-1234-123456781234",
      "url": "mystore2.commerscale.com",
      "redirecturl": "mystore2.commerscale.com",
      "dnsconfigured": "false",
      "resale": "false",
      "default": "false",
      "author": "Mr Example",
      "createdon": "2017-01-06 15:15:01"
   }
]

COUNT

URL

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

Filters

Filter Type
id Array of GUID
url Array of String (max 255 chars)
redirecturl Array of String (max 255 chars)
dnsconfigured Boolean
resale Boolean
default Boolean
createdon_min DateTime
createdon_max DateTime

Request

Count the items

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

Count specific items by url

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'url' : ['mystore1.commerscale.com']
        }
    }

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

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id': ['00000000-0000-0000-0000-000000000000', '12345678-1234-1234-1234-123456781234'],
            'url' : ['mystore1.commerscale.com','mystore2.commerscale.com'],
		    'redirecturl' : ['mystore1.commerscale.com','mystore2.commerscale.com'],
		    'dnsconfigured' : 'false',
		    'resale' : 'false',
		    'default' : 'false',
		    '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"
}