Docs
Content API
Store content
Pages

Pages

Get All Pages (Deprecated)

GET /pages
⚠️
This endpoint is deprecated.

Request

Returns a list of Pages. Default sorting is by auto-generated ID from oldest to newest.

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To get one or more pages, use Pages V3ʼs Get pages endpoint. To get a single page, use Pages V3ʼs Get a page endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • page in query - number

    Filter param.

  • limit in query - number

    Filter param.

example

Response

Body

array | application/json

    example

    Create a Page (Deprecated)

    POST /pages
    ⚠️
    This endpoint is deprecated.

    Request

    Creates a Page. The request payload limit is 1MB.

    Required Fields

    • type
    • name
    • link (for a page of type: link)
    • feed (for a page of type: rss_feed)
    • body (for a page of type: raw)

    Read Only Fields

    • id

    Content Type

    The default value for content_type is text/html; however, if page_type is set to raw, content_type can be changed to text/javascript or application/json. Updating this field lets you place a JavaScript or a JSON file in the root directory.

    Warning

    Deprecated

    • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
    • To create one or more pages, use Pages V3ʼs Create pages endpoint.

    Authentication

    • X-Auth-Token in header
      required

    Parameters

    • store_hash in path - string

    Body

    object | application/json

    • channel_id      number

      channel ID

      Example: 11

    • name      string
      required

      Page name, as displayed on the storefront.

      Example: Contact Form

    • meta_title      string

      Text specified for this page’s <title> element. If empty, the value of the name property is used.

    • body      string
      required

      HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.

      Example: <p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>

    • is_visible      boolean

      If true, this page appears in the storefront’s navigation menu.

      Example: true

    • parent_id      integer

      ID of any parent Web page.

      Example: 5

    • sort_order      integer

      Order in which this page should display on the storefront. (Lower integers specify earlier display.)

      Example: 3

    • meta_keywords      string

      Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.

    • type      string
      required

      page: free-text page link: link to another web address rss_feed: syndicated content from an RSS feed contact_form: When the store’s contact form is used

      Allowed: page | rss_feed | contact_form | raw | link

    • meta_description      string

      Description contained within this page’s <meta/> element.

    • is_homepage      boolean

      If true, this page is the storefront’s home page.

    • is_customers_only      boolean

      If true, this page is for customers only.

    • search_keywords      string

      Comma-separated list of keywords that shoppers can use to locate this page when searching the store.

    • has_mobile_version      boolean

      If true, this page has a mobile version. (For Blueprint themes only)

    • mobile_body      string

      HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint themes only).

      Example: 0

    • contact_fields      string

      Where the page’s type is a contact form: object whose members are the fields enabled (in the control panel) for storefront display. Possible members are:fullname: full name of the customer submitting the form; phone: customer’s phone number, as submitted on the form; companyname: customer’s submitted company name; orderno: customer’s submitted order number; rma: customer’s submitted RMA (Return Merchandise Authorization) number.

      Example: fullname,companyname,phone,orderno,rma

    • url      string

      Relative URL on the storefront for this page.

      Example: /contact-us/

    • layout_file      string

      Layout template for this page. This field is writable only for stores with a Blueprint theme applied.

      Example: page.html

    • feed      string

      If page type is rss_feed then this field is visible. Required in POST required for rss page type.

    • link      string

      If page type is link this field is returned. Required in POST to create a link page.

    • content_type      string

      Allowed: application/json | text/javascript | text/html

      Example: text/html

    example

    Response

    Body

    application/json

    example

    Get A Page (Deprecated)

    GET /pages/{id}
    ⚠️
    This endpoint is deprecated.

    Request

    Returns a Page.

    Warning

    Deprecated

    • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
    • To get a single page, use Pages V3ʼs Get a page endpoint.

    Authentication

    • X-Auth-Token in header
      required

    Parameters

    • store_hash in path - string
    • id in path - integer
      required

      ID of the page.

    example

    Response

    Body

    application/json

    example

    Update a Page (Deprecated)

    PUT /pages/{id}
    ⚠️
    This endpoint is deprecated.

    Request

    Updates a Page. The request payload limit is 1MB.

    Read Only Fields

    • id

    Warning

    Deprecated

    • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
    • To update multiple pages, use Pages V3ʼs Update pages endpoint. To update a single page, use Pages V3ʼs Update a page endpoint.

    Authentication

    • X-Auth-Token in header
      required

    Parameters

    • store_hash in path - string
    • id in path - integer
      required

      ID of the page.

    Body

    application/json

    example

    Response

    Body

    application/json

    example

    Delete a Page (Deprecated)

    DELETE /pages/{id}
    ⚠️
    This endpoint is deprecated.

    Request

    Deletes a Page.

    Warning

    Deprecated

    • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
    • To delete multiple pages, use Pages V3ʼs Delete pages endpoint. To delete a single page, use Pages V3ʼs Delete a page endpoint.

    Authentication

    • X-Auth-Token in header
      required

    Parameters

    • store_hash in path - string
    • id in path - integer
      required

      ID of the page.

    example

    Response

    Did you find what you were looking for?
    Get All Blog TagsGet All Pages (Deprecated)