Add custom pages

Requires write_page access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/store/page/customize.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Add a custom page (supports specifying custom routes)

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

reqobject
[]
request
author string required
[]
Custom page author
[]
Example: "Alvin"
body_html string
[]
Customize the content of the page
[]
Example: "content of the page"
handle string required
[]
Custom page handle
[]
Example: "pagecustomUrl"
published_at string
[]
Release time, format yyyy-MM-dd HH:mm
[]
Example: "2024-06-20 17:50:45.460"
published_status boolean
[]
Whether to publish, optional values: true (published); false (not published)
[]
Example: true
template_name string
[]
The name of the bound template
[]
Example: "templates/page.html"
template_type integer
[]
Template type, optional values: 1 (store); 2 (theme)
[]
Example: 1
title string required
[]
Customize the page title
[]
Example: "title"
url string
[]
Custom route, maximum 512 characters, eg: "/custom-url"
[]
Example: "/custom-url"

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

dataobject
[]
data
author string
[]
Custom page author
[]
Example: "Alvin"
body_html string
[]
Customize the content of the page
[]
Example: "content of the page"
created_at string
[]
Creation time, in the format of yyyy-MM-dd HH:mm
[]
Example: "2024-06-18 18:16:39.792"
handle string
[]
Custom page handle
[]
Example: "pagecustomUrl"
id string
[]
Custom page id
[]
Example: "6515896407215317133"
published_at string
[]
Release time, format yyyy-MM-dd HH:mm
[]
Example: "2024-06-20 17:50:45.460"
published_status boolean
[]
Publish
[]
Example: true
store_id long
[]
Shop ID
template_name string
[]
The name of the bound template
[]
Example: "templates/page.html"
title string
[]
Customize the page title
[]
Example: "title"
updated_at string
[]
Update time, format yyyy-MM-dd HH:mm
[]
Example: "2024-06-20 17:50:45.460"
msg string
[]
error message

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "req": {
    "author": "\"Alvin\"",
    "body_html": "\"content of the page\"",
    "handle": "\"pagecustomUrl\"",
    "published_at": "\"2024-06-20 17:50:45.460\"",
    "published_status": true,
    "template_name": "\"templates/page.html\"",
    "template_type": 1,
    "title": "\"title\"",
    "url": "\"/custom-url\""
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/store/page/customize.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal