SHshoplineapp
Pages

Show Page

Changed on

To show page with open API<br>獲取頁面資訊

get/pages/{pageId}

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/pages/{pageId}
  • Auth
    HTTP bearer

Path parameters

pageIdstring required

Page ID

Query parameters

include[]string[]

extra fields returning with page response

[
  "use_layout_engine_template"
]

Response

OK

idstring

Id of the Page<br>頁面ID

created_atstring

Created Time<br>頁面創造時間

updated_atstring

Updated Time<br>頁面更新時間

status'active' | 'draft' | 'removed' | 'hidden'

Status of the Page<br>頁面狀態

typestring

Type of the Page<br>頁面類別

key'about' | 'terms' | 'policy' | 'others' nullable

Key of the page

seo_keywordsstring

Key of the page

open_outside_windowboolean

Whether the page open outside window<br>頁面是否在視窗外開啟

column_gutterstring

The gutter of column<br>行的間距

row_gutterstring

The gutter of row<br>列的間距

is_product_pageboolean

Whether the page is a product page<br>頁面是否商品頁面

is_hidden_product_visibleboolean

Whether hidden product is visible in the page<br>頁面會否顯示已隱藏商品

use_noindex_meta_tagboolean

Whether the page is searchable on search engines<br>頁面會否被搜尋引擎搜尋到

sectionsobject
sections_orderstring[]
use_layout_engine_templateboolean

Whether the page has Layout Engine template<br>頁面是否使用 Layout Engine template

Example response

{
  "id": "623bf38ab1eba700352f4442",
  "created_at": "2019-12-30T09:16:46.142Z",
  "updated_at": "2019-12-30T09:16:46.142Z",
  "status": "active",
  "type": "section",
  "title_translations": {
    "zh-hant": "文字組合",
    "zh-cn": "文字组合",
    "en": "Text",
    "th": "ข้อความ",
    "vi": "Văn bản"
  },
  "content_translations": {
    "zh-hant": "文字組合",
    "zh-cn": "文字组合",
    "en": "Text",
    "th": "ข้อความ",
    "vi": "Văn bản"
  },
  "key": "about",
  "seo_title_translations": {
    "zh-hant": "文字組合",
    "zh-cn": "文字组合",
    "en": "Text",
    "th": "ข้อความ",
    "vi": "Văn bản"
  },
  "seo_description_translations": {
    "zh-hant": "文字組合",
    "zh-cn": "文字组合",
    "en": "Text",
    "th": "ข้อความ",
    "vi": "Văn bản"
  },
  "seo_keywords": "abc",
  "open_outside_window": true,
  "link": {
    "created_at": "2019-12-30T09:16:46.142+00:00",
    "updated_at": "2019-12-30T09:16:46.142+00:00"
  },
  "sections_order": [
    "623bdfd0779bb6003bab6e6d"
  ],
  "use_layout_engine_template": true
}

Changes