Get custom pages

Requires read_page access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/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 paginated list of custom pages by applying multiple filtering conditions.
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 parameters.
  • created_at_max string
    Specify the latest creation time for custom pages to query. Custom pages created on and before this time are returned. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.120
  • created_at_min string
    Specify the earliest creation time for custom pages to query. Custom pages created on and after this time are returned. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.120
  • handle string
    A unique semantic identifier for the custom page.
    Example: contact-us
  • page_num integer required
    The page number of the paging request.
    Example: 1
  • page_size integer required
    Number of items per page.
    Value range: 1-250
    Default: 50
  • published_at_max string
    Specify the latest published time for custom pages to query. Custom pages published on and before this time are returned. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.120
  • published_at_min string
    Specify the earliest published time for custom pages to query. Custom pages published on and after this time are returned. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.120
  • published_status string
    Publication status of the custom page. Valid values are:
    • any: Pages in any status.
    • published: Published pages.
    • unpublished: Unpublished pages.
    Default value: any
  • search_by_source integer
    Indicates whether to filter by app type. Valid values are:
    • 0: Disabled app type filtering.
    • 1: Filter by app type (for example: Smart Landing Page).
    Default value: 0
  • since_id long
    The ID of a specific custom page. Start querying pages from this specified ID.
    Example: 6497413009837171000
  • sort_field integer
    Sorting criteria. The value is fixed to 1, indicating sorting by update time in ascending order. If not provided or left empty, the default sorting will be based on the unique ID of the custom page.
    Example: 1
  • sort_type integer
    Sorting direction. Valid values are:
    • 0: Ascending order sorting.
    • 1: Descending order sorting.
    Default value: 0.
  • title string
    Title of the custom page.
    Maximum length: 255
    Example: Contact us
  • updated_at_max string
    Specify the latest updated time for custom pages to query. Custom pages updated on and before this time are returned. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.000
  • updated_at_min string
    Specify the earliest updated time for custom pages to query. Custom pages updated on and after this time are returned. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.000
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
    Custom page information.
  • last_page boolean
    Whether the current page is the last page.
    • true: Is the last page.
    • false: Is not the last page.
  • listobject[]
    Custom page list information.
  • author string
    The ID or name of the author for the custom page.
    Example: Alvin
  • body_html string
    The body content of the custom page, formatted in HTML.
    Example: <p>We love to hear from you.</p>
  • created_at string
    Creation time of the custom page. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.000
  • custom_urlobject
    URL of the custom page. Refer to Customize your URL for details on URL customization.
  • is_customized boolean
    Whether the URL is a custom URL.
    • true: The URL is a custom URL.
    • false: The URL is the system default URL.
  • url string
    Relative URL path of the custom page.
    Example: /pages/contact_us
  • handle string
    A unique semantic identifier for the custom page.
    Example: contact-us
  • id string
    The unique ID of the custom page.
    Example: 6743314731912662424
  • published_at string
    Publication time of the custom page. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.000
  • published_status boolean
    Whether the custom page has been published.
    • true: Already published.
    • false: Not yet published.
  • store_id long
    The unique ID of the store.
    Example: 1730104825803
  • template_name string
    Template name used for the custom page.
    Example: templates/page.contact.json
  • template_type integer
    The template type used by the custom page. Valid values are:
    • 0: Default theme template.
    • 1: Public template, available for all themes.
    • 2: App-defined theme template, only effective for the current theme.
  • title string
    Title of the custom page.
    Example: Contact us
  • updated_at string
    Update time of the custom page. Format: yyyy-MM-dd HH:mm:ss.SSS.
    Example: 2023-09-11 16:49:35.000
  • page_num integer
    Page number for paginated requests.
    Example: 1
  • page_size integer
    Number of items per page.
    Example: 50
  • total long
    Total count of returned data entries.
    Example: 50
  • msg string
    Response information, including the reason for success or failure.
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "req": {
    "created_at_max": "2023-09-11 16:49:35.120",
    "created_at_min": "2023-09-11 16:49:35.120",
    "handle": "contact-us",
    "page_num": 1,
    "page_size": 0,
    "published_at_max": "2023-09-11 16:49:35.120",
    "published_at_min": "2023-09-11 16:49:35.120",
    "published_status": null,
    "search_by_source": null,
    "since_id": 6497413009837171000,
    "sort_field": 1,
    "sort_type": null,
    "title": "Contact us",
    "updated_at_max": "2023-09-11 16:49:35.000",
    "updated_at_min": "2023-09-11 16:49:35.000"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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
Get custom pages
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.