API Operations on Pages | Open your online store today and start accepting online payments with the Commerscale e-commerce platform

GET, COUNT, CREATE, UPDATE and DELETE operations available on pages.

Pages Operations

GET

URL

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

Filters

Filter	Type
id	Array of GUID
title	Array of String (max 255 chars)
slug	Array of String (max 255 chars)
homepage	Boolean
secured	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'],
		    'name' : ['Page 1', 'Page 2'],
		    'slug' : ['page-1', 'page-2'],
		    'homepage' : 'false',
		    'secured' : '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: Page). Please refer to error messages to learn more about the possible error responses.

[
   {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "Page 1",
      "slug": "page-1",
      "content": "example",
      "homepage": "false",
      "secured": "false",
      "seopagetitle": "",
      "seometakeywords": "",
      "seopagedescription": "",
      "backgroundfileid": "00000000-0000-0000-0000-000000000000",
      "versions": [
         {
            "id": "30348d8d-0826-4fea-bad7-b47db7214822",
            "content": "",
            "version": "2",
            "createdon": "2016-05-30 11:30:01"
         }
      ],
      "author": "Mr Example",
      "createdon": "2016-05-30 11:27:45"
   },
   {
      "id": "12345678-1234-1234-1234-123456781234",
      "title": "Page 2",
      "slug": "page-2",
      "content": "example",
      "homepage": "false",
      "secured": "false",
      "seopagetitle": "",
      "seometakeywords": "",
      "seopagedescription": "",
      "backgroundfileid": "00000000-0000-0000-0000-000000000000",
      "versions": [
         {
            "id": "8134ca7c-69ff-40e2-a993-b328a8f64d7d",
            "content": "",
            "version": "2",
            "createdon": "2016-08-14 09:49:04"
         },
        {
            "id": "2a2059ba-c8fa-46be-acbd-117020a56c27",
            "content": "",
            "version": "3",
            "createdon": "2016-08-14 09:49:46"
         }
      ],
      "author": "Mr Example",
      "createdon": "2016-08-01 08:17:54"
   }
]

COUNT

URL

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

Filters

Filter	Type
id	Array of GUID
title	Array of String (max 255 chars)
slug	Array of String (max 255 chars)
homepage	Boolean
secured	Boolean
createdon_min	DateTime
createdon_max	DateTime

Request

Count the items

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

Count specific items by name

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'name' : ['Page 1']
        }
    }

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'],
		    'name' : ['Page 1', 'Page 2'],
		    'slug' : ['page-1', 'page-2'],
		    'homepage' : 'false',
		    'secured' : '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"
}

CREATE

URL

POST https://your-secured-store-url:443/api/v1/pages/create

Data properties

Mandatory

Property	Type
title	String (max 255 chars)
slug	String (max 255 chars)
content	String (max 65535 chars)
homepage	Boolean
secured	Boolean
seopagetitle	String (max 255 chars)
seopagedescription	String (max 255 chars)
seometakeywords	String (max 255 chars)
backgroundfileid	GUID (Files)

Request

Most complete request

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    },
    'data' : [{
			'title' : 'Example Page 1',
			'slug' : 'example-1',
			'content' : 'Example',
			'homepage' : 'true',
			'secured' : 'true',
			'seopagetitle' : 'SEO page title',
			'seopagedescription' : 'SEO META description',
			'seometakeywords' : 'SEO META keywords',
			'backgroundfileid' : '1d89ffa3-6098-49af-90b4-8fa6aa15af67'
		}]
}

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.

[
   {
      "id": "57fc3f0a-696f-431a-a74e-7962a39f18d3",
      "title": "Example Page 1",
      "slug": "example-1",
      "content": "Example",
      "homepage": "1",
      "secured": "1",
      "seopagetitle": "SEO page title",
      "seometakeywords": "SEO META keywords",
      "seopagedescription": "SEO META description",
      "backgroundfileid": "1d89ffa3-6098-49af-90b4-8fa6aa15af67",
      "versions": [
         {
            "id": "e8d96d49-601c-45cb-9f1e-b74fcf6ff8cf",
            "content": "Example",
            "version": "1",
            "createdon": "2016-09-13 20:40:51"
         }
      ],
      "author": "Mr Example",
      "createdon": "2016-09-13 20:40:51"
   }
]

UPDATE

URL

POST https://your-secured-store-url:443/api/v1/pages/update

Data properties

Mandatory

Property	Type
id	GUID
title	String (max 255 chars)
slug	String (max 255 chars)
content	String (max 65535 chars)
homepage	Boolean
secured	Boolean
seopagetitle	String (max 255 chars)
seopagedescription	String (max 255 chars)
seometakeywords	String (max 255 chars)
backgroundfileid	GUID (Files)

Request

Most complete request

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    },
	'data' : [
		{
			'id' : '57fc3f0a-696f-431a-a74e-7962a39f18d3',
			'title' : 'Example Page 1',
			'slug' : 'example-1',
			'content' : 'Example',
			'homepage' : 'true',
			'secured' : 'false',
			'seopagetitle' : 'SEO page title',
			'seopagedescription' : 'SEO META description',
			'seometakeywords' : 'SEO META keywords',
			'backgroundfileid' : '1d89ffa3-6098-49af-90b4-8fa6aa15af67'
		}
	]
}

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.

[
   {
      "id": "57fc3f0a-696f-431a-a74e-7962a39f18d3",
      "title": "Example Page 1",
      "slug": "example-1",
      "content": "Example",
      "homepage": "1",
      "secured": "0",
      "seopagetitle": "SEO page title",
      "seometakeywords": "SEO META keywords",
      "seopagedescription": "SEO META description",
      "backgroundfileid": "1d89ffa3-6098-49af-90b4-8fa6aa15af67",
      "versions": [
         {
            "id": "7e660c1d-919d-4d15-a473-4e3854c9822e",
            "content": "Example",
            "version": "2",
            "createdon": "2016-09-13 20:43:44"
         },
         {
            "id": "e8d96d49-601c-45cb-9f1e-b74fcf6ff8cf",
            "content": "Example",
            "version": "1",
            "createdon": "2016-09-13 20:40:51"
         }
      ],
      "author": "Mr Example",
      "createdon": "2016-09-13 20:40:51"
   }
]

DELETE

URL

POST https://your-secured-store-url:443/api/v1/pages/delete

Filters

Filter	Type
id	GUID

Request

Normal request

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    },
    'filter' : [{
        'id': ['57fc3f0a-696f-431a-a74e-7962a39f18d3']
    }]
}

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.

{
   "success": "true"
}

Documentation / API / Operations on Pages

Pages Operations

GET

URL

Filters

Request

Response

COUNT

URL

Filters

Request

Response

CREATE

URL

Data properties

Request

Response

UPDATE

URL

Data properties

Request

Response

DELETE

URL

Filters

Request

Response

Our CMS

Resources

Commerscale

Contact us

Connect us