Get a custom page list

Requires read_page access scope.

For more info , refer to:

[]

access permission

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

[]

Get a custom page list (return to custom route)

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
created_at_max string
[]
Show pages created before this date, in the format: yyyy-MM-dd HH:mm
[]
Example: 2014-04-25T16:15:47-04:00
created_at_min string
[]
Show pages created after this date, in the format yyyy-MM-dd HH:mm
[]
Example: 2014-04-25T16:15:47-04:00
handle string
[]
Custom page handle
[]
Example: "pagecustomUrl"
page_num integer required
[]
page number
[]
Example: 1
page_size integer required
[]
The number of displayed items cannot exceed 250, the default is 50
[]
Example: 50
published_at_max string
[]
Show pages published before this date
[]
Example: 2014-04-25T16:15:47-04:00
published_at_min string
[]
Show pages published after this date
[]
Example: 2014-04-25T16:15:47-04:00
published_status string
[]
Publishing status, enumeration value: any (all); published (published); unpublished (unpublished)
[]
Example: true
search_by_source integer
[]
Whether to query based on source, 1 (yes); 0 (no)
[]
Example: 1
since_id long
[]
Only search for pages after this ID
sort_field integer
[]
Sorting field, optional value: 1 (indicates sorting by update time); default sorting is by id
[]
Example: 1
sort_type integer
[]
Sorting type, optional values: 0 (ascending, default); 1 (descending)
[]
Example: 1
title string
[]
Customize the page title
[]
Example: "title"
updated_at_max string
[]
Show pages updated before this date, in the format: yyyy-MM-dd HH:mm
[]
Example: 2014-04-25T16:15:47-04:00
updated_at_min string
[]
Show pages updated after this date, in the format: yyyy-MM-dd HH:mm
[]
Example: 2014-04-25T16:15:47-04:00

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

dataobject
[]
Response Information
last_page boolean
[]
Is it the last page, true (yes); false (no)
[]
Example: true
listobject[]
[]
Custom Page List
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, format: yyyy-MM-dd HH:mm
.SSS
[]
Example: "2024-06-20 17:50:45.460"
custom_urlobject
[]
Custom URLs for products on your store
is_customized string
[]
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
[]
Custom page handle
[]
Example: "pagecustomUrl"
id string
[]
Custom page id
[]
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, optional values: 1 (store); 2 (theme)
[]
Example: 1
title string
[]
Customize the page title
[]
Example: "title"
updated_at string
[]
Update time, format: yyyy-MM-dd HH:mm
.SSS
[]
Example: "2024-06-20 17:50:45.460"
page_num integer
[]
page number
[]
Example: 1
page_size integer
[]
Page size
[]
Example: 50
total long
[]
The total amount
[]
Example: 50
msg string
[]
error message

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "req": {
    "created_at_max": "2014-04-25T16:15:47-04:00",
    "created_at_min": "2014-04-25T16:15:47-04:00",
    "handle": "\"pagecustomUrl\"",
    "page_num": 1,
    "page_size": 50,
    "published_at_max": "2014-04-25T16:15:47-04:00",
    "published_at_min": "2014-04-25T16:15:47-04:00",
    "published_status": "true",
    "search_by_source": 1,
    "since_id": 0,
    "sort_field": 1,
    "sort_type": 1,
    "title": "\"title\"",
    "updated_at_max": "2014-04-25T16:15:47-04:00",
    "updated_at_min": "2014-04-25T16:15:47-04:00"
  }
}

Language

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