查询自定义页面

需要 read_page 权限点。
更多权限点使用信息，请参考：
访问权限。
POST https://{handle}.myshopline.com/admin/openapi/v20260301/store/page/customize/list.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
通过多种条件筛选，分页返回指定自定义页面或列表。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
  • reqobject required
    请求参数。
  • created_at_max string
    指定要查询自定义页面的截止创建时间。在此时间和此时间之前创建的自定义页面会被返回。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.120
  • created_at_min string
    指定要查询自定义页面的起始创建时间。在此时间和此时间之后创建的自定义页面会被返回。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.120
  • handle string
    自定义页面的语义化标识符。
    例子: contact-us
  • page_num integer required
    分页请求的页码。
    例子: 1
  • page_size integer required
    每页返回的数据条数。
    取值范围：1-250
    默认取值为：50
  • published_at_max string
    指定要查询自定义页面的截止发布时间。在此时间和此时间之前发布的自定义页面会被返回。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.120
  • published_at_min string
    指定要查询自定义页面的起始发布时间。在此时间和此时间之后发布的自定义页面会被返回。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.120
  • published_status string
    自定义页面的发布状态。有效枚举值包含：
    • any：所有状态的页面。
    • published：已发布页面。
    • unpublished：未发布页面。
    默认取值为any。
  • search_by_source integer
    是否根据应用类型查询。有效枚举值包含：
    • 0：不根据应用类型查询。
    • 1：根据应用类型查询（例如：智能落地页）。
    默认取值为0
  • since_id long
    自定义页面 ID。传入该值后，会从指定的页面 ID 开始查询页面。
    例子: 6497413009837171000
  • sort_field integer
    排序依据，枚举值固定为 1，表示按更新时间顺序排序。不传或为空默认按自定义页面的唯一标识 ID 排序。
    例子: 1
  • sort_type integer
    排序方向。有效枚举值包含：
    • 0：升序排序。
    • 1：降序排序。
    默认取值为 0。
  • title string
    自定义页面的标题。
    最大长度限制：255
    例子: Contact us
  • updated_at_max string
    指定要查询自定义页面的截止更新时间。在此时间和此时间之前更新的自定义页面会被返回。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.000
  • updated_at_min string
    指定要查询自定义页面的起始更新时间。在此时间和此时间之后更新的自定义页面会被返回。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.000
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • dataobject
    自定义页面信息。
  • last_page boolean
    查询的页码是否是最后一页。
    • true：是最后一页。
    • false：不是最后一页。
  • listobject[]
    自定义页面列表信息。
  • author string
    自定义页面的创建者 ID 或名称。
    例子: Alvin
  • body_html string
    自定义页面的正文内容，包含 HTML 标签。
    例子: <p>We love to hear from you.</p>
  • created_at string
    自定义页面的创建时间。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.000
  • custom_urlobject
    自定义页面 URL。详情参考 URL 结构设置 了解自定义 URL 相关内容。
  • is_customized boolean
    是否为自定义 URL。
    • true：该 URL 为自定义 URL。
    • false：该 URL 为系统默认 URL。
  • url string
    自定义页面 URL 的相对路径。
    例子: /pages/contact_us
  • handle string
    自定义页面的语义化标识符。
    例子: contact-us
  • id string
    自定义页面的唯一标识 ID。
    例子: 6743314731912662424
  • published_at string
    自定义页面的发布时间。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.000
  • published_status boolean
    是否发布自定义页面。
    • true：已发布。
    • false：未发布。
  • store_id long
    店铺的唯一标识 ID。
    例子: 1730104825803
  • template_name string
    自定义页面使用的模版名称。
    例子: templates/page.contact.json
  • template_type integer
    自定义页面使用的模版类型。模版类型包含：
    • 0：默认主题模板。
    • 1：公共模版，所有主题均可使用。
    • 2：通过应用定义的主题模版，仅对当前主题生效 。
  • title string
    自定义页面的标题。
    例子: Contact us
  • updated_at string
    自定义页面的更新时间。格式：yyyy-MM-dd HH:mm:ss.SSS。
    例子: 2023-09-11 16:49:35.000
  • page_num integer
    分页请求的页码。
    例子: 1
  • page_size integer
    每页返回的数据条数。
    例子: 50
  • total long
    返回数据的总条数。
    例子: 50
  • msg string
    响应信息，包含成功或失败原因。
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
查询自定义页面
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"
}
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.