Get a custom page list

Requires read_page access scope.
For more info , refer to:
POST https://{handle}.myshopline.com/admin/openapi/v20230301/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 .
Query custom page list
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 parameters
  • created_at_max string
    Show pages created before this date , format : yyyy-MM-dd HH : mm : ss
    Example: 2022-12-27 17:17:02
  • created_at_min string
    Show pages created after this date , format : yyyy-MM-dd HH : mm : ss
    Example: 2022-12-27 17:17:02
  • handle string
    Zidingyi for custom pages
    Example: page_handle
  • page_num integer required
    Page number
    Example: 1
  • page_size integer required
    Displayed number, cannot exceed 250, default 50
    Example: 10
  • search_by_source integer
    Whether to query according to the source, 1 (yes); 0 (no)
    Example: 1
  • since_id long
    Only query pages after this ID
    Example: 5734528158155678000
  • sort_field integer
    Sorting field , optional value : 1 ( according to the update time ) ; default sorting by id
    Example: 1
  • sort_type integer
    Sorting type , optional value : 0 ( ascending , default ) ; 1 ( descending )
  • title string
    Title of custom page
    Example: demo-page
  • updated_at_max string
    Show pages updated before this date , format : yyyy-MM-dd HH : mm : ss
    Example: 2022-12-27 17:17:02
  • updated_at_min string
    Show pages updated after this date , format : yyyy-MM-dd HH : mm : ss
    Example: 2022-12-27 17:17:02
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
Response Body
  • dataobject
    Response information
  • last_page boolean
    Last page , true ( yes ) ; false ( no ) or not
    Example: true
  • listobject[]
    Custom page list
  • author string
    Author of custom pages
    Example: 4200057040
  • body_html string
    Content of the custom page
    Example: <p>demo-page-content</p>
  • created_at string
    Created time , format : yyyy-MM-dd HH : mm : ss.SSS
    Example: 2022-12-27 17:17:02
  • handle string
    The handle of the custom page
    Example: page_handle
  • id string
    Id for custom pages
    Example: 5734528158155677719
  • store_id long
    store ID
    Example: 1628737575003
  • template_name string
    Template name
    Example: templates/page.json
  • template_type integer
    Template type , optional value : 1 ( shop ) ; 2 ( theme )
    Example: 2
  • title string
    Title of custom page
    Example: demo-page
  • updated_at string
    Update time , format : yyyy-MM-dd HH : mm : ss.SSS
    Example: 2022-12-27 17:17:02
  • page_num integer
    Page number
    Example: 1
  • page_size integer
    Page size
    Example: 10
  • total long
    Total quantity
    Example: 100
  • msg string
    Error message
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20230301

ParamOptions

— header required

Body

required
{
  "req": {
    "created_at_max": "2022-12-27 17:17:02",
    "created_at_min": "2022-12-27 17:17:02",
    "handle": "page_handle",
    "page_num": 1,
    "page_size": 10,
    "search_by_source": 1,
    "since_id": 5734528158155678000,
    "sort_field": 1,
    "sort_type": 0,
    "title": "demo-page",
    "updated_at_max": "2022-12-27 17:17:02",
    "updated_at_min": "2022-12-27 17:17:02"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20230301/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'
Examples
Query custom page list
Request
{
  "req": {
    "page_num": "1",
    "page_size": "2",
    "since_id": "5734528158155677719"
  }
}
Response
{
  "data": {
    "last_page": true,
    "list": [
      {
        "author": "zhang san",
        "body_html": "<p>demo-page-content</p>",
        "created_at": "2022-12-27 17:17:02.868",
        "handle": "page_handle",
        "id": "5734528158155677719",
        "store_id": "1628737575003",
        "template_name": "templates/page.json",
        "template_type": "2",
        "title": "demo-page",
        "updated_at": "2022-12-27 17:17:02.868"
      }
    ],
    "page_num": 1,
    "page_size": 2,
    "total": 1
  },
  "msg": "success"
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.

Error loading component.

Error loading component.