Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Pages

(ms.pages)

It contains the static pages required for a site, such as About us, etc.

Fields
EndPoints

Fields

Value Description
title   
Type: string
Required
The title of the page.
Size-charts
alias   
Type: string
Alias is the unique page URL on storefront.
size-charts
content   
Type: string
Content of the static page. It can be styled using html tags.
<table border="1" cellpadding="1" cellspacing="1" style="height: 10px; width: 500px; text-align: center;">
<tbody>
<tr>
<td rowspan="2">US/CANADA</td>
<td>XS</td>
<td>S</td>
<td>M</td>
<td>L</td>
<td>XL</td>
</tr>
<tr>
<td>2</td>
<td>4,6</td>
<td>8,10</td>
<td>12,14</td>
<td>14,16</td>
</tr>
</tbody>
</table>
SEO   
Type: object
SEO contains data that affects the online visibility of a page on search engine.
{
  "SEO":{
    "title": "policies",
    "description": "docs for policy",
    "keywords": "policy",
    "canonical_url": "abcd.def.com"
      }
}
title
Type: string
The title of the product to specify a custom title of the page for SEO.
description
Type: string
The description is used to specify a custom meta description for the page for SEO.
keywords
Type: string
Keywords are used to specify a custom meta keywords for the page for SEO.
canonical_url
Type: string
The canonical URL is used to declare a single page as its source or for duplicate pages to reference their source/originating page.
sitemap_priority
Type: string
Sitemap priority defines the priority of the particular page in your store.
publish   
Type: string
Enabling the flag makes the page visible on storefront.
1

Commands (Endpoints)

POST /api/1.1/entity/ms.pages   
Creates a new page
DEL /api/1.1/entity/ms.pages/{resource_id}   
Deletes a page
PUT /api/1.1/entity/ms.pages/{resource_id}   
Updates an existing page
GET /api/1.1/entity/ms.pages/{resource_id}   
Retrieves a single page
GET /api/1.1/entity/ms.pages   
Retrieves a list of pages