Query page's detail information

Requires read_page access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/store/page/customize/id.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 .

Supports querying custom page details by page ID (returns custom route)

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

reqobject required

request
page_id string required

pageId
Example: 6515896407215317133

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

dataobject

data
author string

Administrator Name
Example: "Alvin"
body_html string

HTML Document
Example: "content of the page"
created_at string

Creation time, in the format of yyyy-MM-dd HH:mm
.SSS
Example: "2024-06-18 18:16:39.792"
custom_urlobject

Custom URLs for products on your store
is_customized boolean

Whether to customize
Example: true
url string

The product URL on the store, greater than or equal to 0 characters and less than or equal to 512 characters
Example: "/custom-url"
handle string

Page handle, format /page/{handle}
Example: "pagecustomUrl"
id string

pageId
Example: "6515896407215317133"
published_at string

Release time, format yyyy-MM-dd HH:mm
.SSS
Example: "2024-06-20 17:50:45.460"
published_status boolean

Publish
Example: true
store_id long

Shop ID
template_name string

Template Name
Example: "templates/page.html"
template_type integer

Template Type
title string

page title
Example: "title"
updated_at string

Update time, format yyyy-MM-dd HH:mm
.SSS
Example: "2024-06-20 17:50:45.460"
msg string

error message

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "req": {
    "page_id": "6515896407215317133"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/store/page/customize/id.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