English

简体中文

English

简体中文

About Page ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Create pages within the store to hold static content, such as an "About Us" page, a "Contact Us" page, and so on.

Endpoints

POST /api/202412/pages: Create custom page

PUT /api/202412/pages/{pageId}: Update custom page

DELETE /api/202412/pages/{page_id}: Delete custom specified page

GET /api/202412/pages/{page_id}: Get custom page details

Page Object ​

The HTML content is stored using the Page resource. With the Page resource, you can manage the web pages in your store. It is mainly used for maintaining static content that doesn't change frequently.

Properties ​

pageobjectrequired
Page object.
- Hide child properties
titlestringrequired
Page tiltle.
seoTitlestring
SEO title, default is page title.
handlestring
Page handle.
contentstring
Page content.
seoDescriptionstring
Search engine optimization (SEO) description, empty by default.
templateNamestring
The name of the theme template associated with the page.
visibleboolean
Whether the page is visible.
publishTimestring
Page published time.
bash
{
  "page": {
    "publishTime": "2024-11-11T10:05:19Z",
    "visible": "true",
    "templateName": "contact",
    "seoDescription": "Learn more about Brand – our values, mission, and the team behind the scenes.",
    "handle": "about-us",
    "title": "About Us - Our Story and Mission",
    "seoTitle": "About Us | Brand Name",
    "content": "<h1>Welcome to Our Company</h1><p>We are dedicated to providing the best service.</p>"
  }
}

POST Create custom page ​

Create custom pages.

Access scope

Requires ANY of the following access scopes: write_content

Endpoint

POST /api/202412/pages 

Request Params

pageobjectrequired
Page detail info.
- Hide child properties
publishTimestring
Page published time (ISO 8601 format).
visiblestring
Indicates whether the page is visible or not.
templateNamestring
Indicates the name of the theme template associated with the page.
seoDescriptionstring
Indicates the search optimization description. The default value is null.
contentstringrequired
Indicates the custom page content, the string length cannot exceed 10,000.
handlestringrequired
Indicates the page handle. The value is defined by the product.
titlestringrequired
Indicates the custom page title, the string length cannot exceed 255.
seoTitlestring
Indicates the search optimization title. The default value is the page title.
coverByHandleboolean
Indicates whether to overwrite existing data based on the handle.

Response Data

pageobjectrequired
Page detail info.
- Hide child properties
handlestring
Indicates the page handle.
idstringrequired
Indicates the page ID.
titlestring
Indicates the custom page title.
templateNamestring
Indicates the name of the theme template associated with the page.
contentstring
Indicates the custom page content.
publishTimestring
Indicates the page published time (ISO 8601 format).
visibleboolean
Indicates whether the page is visible or not.
seoTitlestring
Indicates the search optimization title. The default value is the page title.
seoDescriptionstring
Indicates the search optimization description. The default value is null.
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/pages" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"page":{
		"coverByHandle":"true",
		"publishTime":"2025-01-10T11:00:00Z",
		"visible":"true",
		"templateName":"custom",
		"seoDescription":"This is a custom page demo",
		"handle":"demo",
		"title":"Custom page demo",
		"seoTitle":"Custom page title",
		"content":"<div class=\"rfq_form_page\"><div class=\"loader\"></div></div>"
	}
}'
json
HTTP/1.1 200 OK
{
  "page": {
    "publishTime": "2025-01-10T11:00:00Z",
    "visible": "true",
    "templateName": "custom",
    "seoDescription": "This is a custom page demo",
    "handle": "demo",
    "id": "1",
    "title": "Custom page demo",
    "seoTitle": "Custom page title",
    "content": "<div class=\"rfq_form_page\"><div class=\"loader\"></div></div>"
  }
}

PUT Update custom page ​

Update custom pages.

Access scope

Requires ANY of the following access scopes: write_content

Endpoint

PUT /api/202412/pages/{pageId} 

Request Params

pageobjectrequired
Page detail.
- Hide child properties
publishTimestring
Page published time (ISO 8601 format).
visiblestring
Indicates whether the page is visible or not.
templateNamestring
Indicates the name of the theme template associated with the page.
seoDescriptionstring
Indicates the search optimization description. The default value is null.
contentstringrequired
Indicates the custom page content, the string length cannot exceed 10,000.
handlestringrequired
Indicates the page handle. The value is defined by the product.
titlestringrequired
Indicates the custom page name, the string length cannot exceed 255.
seoTitlestring
Indicates the search optimization title. The default value is the page title.

Response Data

pageobjectrequired
Page detail.
- Hide child properties
publishTimestring
Page published time (ISO 8601 format).
visiblestring
Indicates whether the page is visible or not.
templateNamestring
Indicates the name of the theme template associated with the page.
seoDescriptionstring
Indicates the search optimization description.
handlestring
Indicates the page handle.
idstringrequired
Indicates the page ID.
titlestring
Indicates the page title.
seoTitlestring
Indicates the SEO title.
contentstring
Indicates the page content.
bash
curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/pages/{pageId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"page":{
		"publishTime":"2025-01-10T11:00:00Z",
		"visible":"true",
		"templateName":"custom",
		"seoDescription":"This is a custom page demo.",
		"handle":"demo",
		"title":"Custom page demo",
		"seoTitle":"Custom page title",
		"content":"<div class=\"rfq_form_page\"><div class=\"loader\"></div></div>"
	}
}'
json
HTTP/1.1 200 OK
{
  "page": {
    "publishTime": "2025-01-10T11:00:00Z",
    "visible": "true",
    "templateName": "custom",
    "seoDescription": "This is a custom page demo.",
    "handle": "demo",
    "id": "1",
    "title": "Custom page demo",
    "seoTitle": "Custom page title",
    "content": "<div class=\"rfq_form_page\"><div class=\"loader\"></div></div>"
  }
}

DELETE Delete custom specified page ​

Delete custom specified page.

Access scope

Requires ANY of the following access scopes: write_content

Endpoint

DELETE /api/202412/pages/{page_id} 

Request Params

pageIdnumberrequired
custom page id

Response Data

{}
bash
curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/pages/{page_id}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{}

GET Get custom page details ​

Get custom page details.

Access scope

Requires ANY of the following access scopes: read_content

Endpoint

GET /api/202412/pages/{page_id} 

Request Params

pageIdnumberrequired
Custom page ID.

Response Data

pageobjectrequired
Page details.
- Hide child properties
publishTimestring
Page published time (ISO 8601 format).
visiblestring
Indicates whether the page is visible or not.
templateNamestring
Indicates the name of the theme template associated with the page.
seoDescriptionstring
Indicates the search optimization description.
handlestringrequired
Indicates the page handle.
idstringrequired
Indicates the page ID.
titlestringrequired
Indicates the page title.
seoTitlestring
Indicates the SEO title.
contentstring
Indicates the page content.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/pages/{page_id}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "page": {
    "publishTime": "2025-01-10T11:00:00Z",
    "visible": "true",
    "templateName": "custom",
    "seoDescription": "This is a custom page demo.",
    "handle": "demo",
    "id": "1",
    "title": "Custom page demo",
    "seoTitle": "Custom page title",
    "content": "<div class=\"rfq_form_page\"><div class=\"loader\"></div></div>"
  }
}