页面
除了在线店面外,Shopify商店还提供了用于创建基本HTML网页的工具。商店所有者可以创建任意数量的页面来保存静态内容,例如“关于我们”页面,“联系我们”页面或带有客户推荐的页面。
这些网页由Page资源表示,它们的HTML内容包含在body_html
属性的值中。页面资源使您可以检索,创建,更新和删除商店的网页。
页面旨在用于很少变化的长期静态内容。要定期创建内容,请改用Blog资源。
Page可以做什么
Shopify API使您可以对Page资源执行以下操作。这些常规操作的更详细的版本可能可用:
- GET /admin/api/2021-01/pages.json检索页面列表
- GET /admin/api/2021-01/pages/count.json检索页数
- GET /admin/api/2021-01/pages/{page_id}.json通过其ID检索单个页面
- POST /admin/api/2021-01/pages.json创建一个新页面
- PUT /admin/api/2021-01/pages/{page_id}.json更新页面
- 删除/admin/api/2021-01/pages/{page_id}.json删除页面
页面属性
作者 | plain "author": "Lydia" 创建页面的人的名字。 |
---|---|
body_html | plain "body_html": "Contact us at <a href=\\"mailto:contact@johns-apparel.com\\">contact@johns-apparel.com</a>." 页面的文本内容,带有HTML标记。 |
created_at 只读 | plain "created_at": "2008-07-15T20:00:00-04:00" 创建页面时的日期和时间(ISO 8601格式)。 |
处理 | plain "handle": "contact-us" 页面的唯一,友好的字符串,从其标题自动生成。在在线商店主题中,Liquid模板语言通过其句柄引用页面。 |
ID 只读 | plain "id": 131092082 页面的唯一数字标识符。 |
元场 | plain "metafield": { "key": "new", "value": "new value", "value_type": "string", "namespace": "global" } 附加到Page对象的附加信息。它具有以下属性:+ key:元字段的标识符。(最多30个字符) + namespace:一组元数据的容器。命名空间有助于区分由不同应用创建的元数据。(最多20个字符) + value:要存储为元数据的信息。 + value_type:要存储的信息类型。有效值: string 或integer 。+ description(可选):有关元字段的其他信息。 有关将元数据附加到Shopify资源的更多信息,请参见Metafield资源。 |
已发布 | plain "published_at": "2014-07-16T20:00:00-04:00" 页面发布的日期和时间(ISO 8601格式)。null 隐藏页面时返回。 |
shop_id 只读 | plain "shop_id": 690933842 该页面所属商店的ID。 |
template_suffix | plain "template_suffix": "contact" 使用的Liquid模板的后缀。例如,如果值为contact ,则页面正在使用page.contact.liquid 模板。如果该值为空字符串,则该页面正在使用默认page.liquid 模板。 |
标题 | plain "title": "Contact us" 页面标题。 |
Updated_at 只读 | plain "updated_at": "2008-07-16T20:00:00-04:00" 页面上次更新的日期和时间(ISO 8601格式)。 |
终点
得到/admin/api/2021-01/pages.json 检索所有页面的列表。注意:从2019-10版本开始,此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>
参数将返回错误。要了解更多信息,请参阅向分页的REST Admin API端点发出请求。
限制 | 要显示的最大结果数。 (默认值: 50 最大: 250 ) |
---|---|
since_id | 将结果限制为指定的ID之后。 |
标题 | 检索具有给定标题的页面。 |
处理 | 检索具有给定句柄的页面。 |
created_at_min | 显示在日期之后创建的页面(格式:2008-12-31)。 |
created_at_max | 显示在日期之前创建的页面(格式:2008-12-31)。 |
Updated_at_min | 显示页面在日期之后最后更新(格式:2008-12-31)。 |
Updated_at_max | 显示页面的最后更新日期为日期(格式:2008-12-31)。 |
Published_at_min | 显示在日期之后发布的页面(格式:2014-04-25T16:15:47-04:00)。 |
published_at_max | 显示在日期之前发布的页面(格式:2014-04-25T16:15:47-04:00)。 |
领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
已发布状态 | 将结果限制为具有给定发布状态的页面: (默认值: any ) + 已发布:仅显示已发布的页面。 + 未发布:仅显示未发布的页面。 + 任何:显示已发布和未发布的页面。 |
获取商店的所有页面
GET /admin/api/2021-01/pages.json
检索指定ID之后的所有页面的列表
GET /admin/api/2021-01/pages.json?since_id=108828309
得到/admin/api/2021-01/pages/count.json 检索页数。标题 | 计算具有给定标题的页面。 |
---|---|
created_at_min | 计算在日期之后创建的页面(格式:2008-12-31)。 |
created_at_max | 计算在日期之前创建的页面(格式:2008-12-31)。 |
Updated_at_min | 计数页面更新日期(格式:2008-12-31)。 |
Updated_at_max | 计算在日期之前最后更新的页面(格式:2008-12-31)。 |
Published_at_min | 显示在日期之后发布的页面(格式:2014-04-25T16:15:47-04:00)。 |
published_at_max | 显示在日期之前发布的页面(格式:2014-04-25T16:15:47-04:00)。 |
已发布状态 | 计算具有给定发布状态的页面: (默认值: any ) + 已发布:计算已发布的页面数。 + 未发布:计算未发布的页面。 + 任何:统计已发布和未发布的页面。 |
检索所有页面的计数
GET /admin/api/2021-01/pages/count.json
得到/admin/api/2021-01/pages/{page_id}.json 通过其ID检索单个页面。领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
---|---|
检索单个页面
GET /admin/api/2021-01/pages/131092082.json
邮政/admin/api/2021-01/pages.json 创建一个页面。创建带有HTML标记的页面
POST /admin/api/2021-01/pages.json
{
“页面” : {
“ title” :“保修信息”,
“ body_html” :“ <h2>保修</ h2> \ n <p>如果我们在购买后<strong> 30天</ strong>收到商品,我们将退货。</ p>
}
}
创建一个未发布的页面
POST /admin/api/2021-01/pages.json
{
“页面” : {
“ title” :“保修信息”,
“ body_html” :“ <h2>保修</ h2> \ n <p>如果我们在购买后<strong> 30天</ strong>收到商品,我们将退货。</ p>,
“已发布” :false
}
}
创建没有标题的页面失败并返回错误
POST /admin/api/2021-01/pages.json
{
“页面” : {
“ body” :“ foobar”
}
}
创建带有元字段的页面
POST /admin/api/2021-01/pages.json
{
“页面” : {
“ title” :“保修信息”,
“ body_html” :“ <h2>保修</ h2> \ n <p>如果我们在购买后<strong> 30天</ strong>收到商品,我们将退货。</ p>,
“ metafields” : [
{
“ key” :“ new”,
“值” :“新值”,
“ value_type” :“字符串”,
“ namespace” :“ global”
}
]
}
}
放/admin/api/2021-01/pages/{page_id}.json 更新页面。完全更新现有页面
PUT /admin/api/2021-01/pages/131092082.json
{
“页面” : {
“ id” :131092082,
“ body_html” :“ <p>如果我们在购买后<strong> 14天</ strong>收到商品,则退货。</ p>,
“作者” :“克里斯托弗·戈尔斯基”,
标题:新保修,
“ handle” :“新保修”
}
}
显示隐藏的页面
PUT /admin/api/2021-01/pages/131092082.json
{
“页面” : {
“ id” :131092082,
“已发布” :是
}
}
隐藏已发布的页面
PUT /admin/api/2021-01/pages/131092082.json
{
“页面” : {
“ id” :131092082,
“已发布” :false
}
}
将元字段添加到页面
PUT /admin/api/2021-01/pages/131092082.json
{
“页面” : {
“ id” :131092082,
“ metafields” : [
{
“ key” :“ new”,
“值” :“新值”,
“ value_type” :“字符串”,
“ namespace” :“ global”
}
]
}
}
更新现有页面的正文HTML
PUT /admin/api/2021-01/pages/131092082.json
{
“页面” : {
“ id” :131092082,
“ body_html” :“ <p>如果我们在购买后14天收到商品,则退货。</ p>”
}
}
删除/admin/api/2021-01/pages/{page_id}.json 删除页面。删除页面
删除/admin/api/2021-01/pages/131092082.json