Pages | BigCommerce Dev Center

Get All Pages

GET https://api.bigcommerce.com/stores/{store_hash}/v2/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
Accept in header with default of application/json - string - required
The MIME type of the response body.
page in query - number
Filter param.
limit in query - number
Filter param.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/pages' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

array | application/json

example

[
  {
    "id": 44,
    "parent_id": 5,
    "type": "page",
    "contact_fields": "fullname,companyname,phone,orderno,rma",
    "email": "janedoes@example.com",
    "name": "Contact Form",
    "url": "/contact-us/",
    "meta_description": "string",
    "body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>",
    "mobile_body": "0",
    "has_mobile_version": false,
    "is_visible": true,
    "is_homepage": false,
    "meta_title": "string",
    "layout_file": "page.html",
    "sort_order": 3,
    "search_keywords": "string",
    "meta_keywords": "string",
    "feed": "string",
    "link": "string",
    "content_type": "text/html"
  }
]

Create a Page

POST https://api.bigcommerce.com/stores/{store_hash}/v2/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 allows you to 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
Content-Type in header with default of application/json - string - required
The MIME type of the request body.

Body

object | application/json

parent_idinteger
ID of any parent Web page.
Example: 5
typestring
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
contact_fieldsstring
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
emailstring
Where the page’s type is a contact form: email address that receives messages sent via the form.
Example: janedoes@example.com
namestring
required
Page name, as displayed on the storefront.
Example: Contact Form
urlstring
Relative URL on the storefront for this page.
Example: /contact-us/
meta_descriptionstring
Description contained within this page’s <meta/> element.
bodystring
required
HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.
Example: We're happy to answer questions or help you with returns. Please fill out the form below if you need assistance.
mobile_bodystring
HTML to use for this page's body when viewed in the mobile template (deprecated).
Example: 0
has_mobile_versionboolean
If true, this page has a mobile version.
Example: false
is_visibleboolean
If true, this page appears in the storefront’s navigation menu.
Example: true
is_homepageboolean
If true, this page is the storefront’s home page.
Example: false
meta_titlestring
Text specified for this page’s <title> element. (If empty, the value of the name property is used.)
layout_filestring
Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
Example: page.html
sort_orderinteger
Order in which this page should display on the storefront. (Lower integers specify earlier display.)
Example: 3
search_keywordsstring
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
meta_keywordsstring
Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.
feedstring
If page type is rss_feed then this field is visible. Required in POST required for rss page type.
linkstring
If page type is link this field is returned. Required in POST to create a link page.
content_typestring
Allowed: application/json | text/javascript | text/html
Example: text/html

example-1

{
  "parent_id": 5,
  "type": "page",
  "contact_fields": "fullname,companyname,phone,orderno,rma",
  "email": "janedoes@example.com",
  "name": "Contact Form",
  "url": "/contact-us/",
  "meta_description": "string",
  "body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>",
  "mobile_body": "0",
  "has_mobile_version": false,
  "is_visible": true,
  "is_homepage": false,
  "meta_title": "string",
  "layout_file": "page.html",
  "sort_order": 3,
  "search_keywords": "string",
  "meta_keywords": "string",
  "feed": "string",
  "link": "string",
  "content_type": "text/html"
}

Response

Body

application/json

idinteger
ID of the page.
Example: 44

parent_idinteger
ID of any parent Web page.
Example: 5
typestring
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
contact_fieldsstring
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
emailstring
Where the page’s type is a contact form: email address that receives messages sent via the form.
Example: janedoes@example.com
namestring
Page name, as displayed on the storefront.
Example: Contact Form
urlstring
Relative URL on the storefront for this page.
Example: /contact-us/
meta_descriptionstring
Description contained within this page’s <meta/> element.
bodystring
HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.
Example: We're happy to answer questions or help you with returns. Please fill out the form below if you need assistance.
mobile_bodystring
HTML to use for this page's body when viewed in the mobile template (deprecated).
Example: 0
has_mobile_versionboolean
If true, this page has a mobile version.
Example: false
is_visibleboolean
If true, this page appears in the storefront’s navigation menu.
Example: true
is_homepageboolean
If true, this page is the storefront’s home page.
Example: false
meta_titlestring
Text specified for this page’s <title> element. (If empty, the value of the name property is used.)
layout_filestring
Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
Example: page.html
sort_orderinteger
Order in which this page should display on the storefront. (Lower integers specify earlier display.)
Example: 3
search_keywordsstring
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
meta_keywordsstring
Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.
feedstring
If page type is rss_feed then this field is visible.
linkstring
If page type is link this field is returned.
content_typestring
Allowed: application/json | text/javascript | text/html
Example: text/html

example

{
  "id": 6,
  "parent_id": 5,
  "type": "page",
  "contact_fields": "fullname,companyname,phone,orderno,rma",
  "email": "janedoes@example.com",
  "name": "Contact Form",
  "url": "/contact-us/",
  "meta_description": "",
  "body": "We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.",
  "mobile_body": "",
  "has_mobile_version": false,
  "feed": "",
  "link": "",
  "is_visible": true,
  "is_homepage": false,
  "layout_file": "page.html",
  "sort_order": 3,
  "meta_title": "",
  "search_keywords": "",
  "meta_keywords": ""
}

Get A Page

GET https://api.bigcommerce.com/stores/{store_hash}/v2/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
Accept in header with default of application/json - string - required
The MIME type of the response body.
id in path - integer - required
ID of the page.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/pages/[id]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

application/json

idinteger
ID of the page.
Example: 44

parent_idinteger
ID of any parent Web page.
Example: 5
typestring
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
contact_fieldsstring
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
emailstring
Where the page’s type is a contact form: email address that receives messages sent via the form.
Example: janedoes@example.com
namestring
Page name, as displayed on the storefront.
Example: Contact Form
urlstring
Relative URL on the storefront for this page.
Example: /contact-us/
meta_descriptionstring
Description contained within this page’s <meta/> element.
bodystring
HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.
Example: We're happy to answer questions or help you with returns. Please fill out the form below if you need assistance.
mobile_bodystring
HTML to use for this page's body when viewed in the mobile template (deprecated).
Example: 0
has_mobile_versionboolean
If true, this page has a mobile version.
Example: false
is_visibleboolean
If true, this page appears in the storefront’s navigation menu.
Example: true
is_homepageboolean
If true, this page is the storefront’s home page.
Example: false
meta_titlestring
Text specified for this page’s <title> element. (If empty, the value of the name property is used.)
layout_filestring
Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
Example: page.html
sort_orderinteger
Order in which this page should display on the storefront. (Lower integers specify earlier display.)
Example: 3
search_keywordsstring
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
meta_keywordsstring
Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.
feedstring
If page type is rss_feed then this field is visible.
linkstring
If page type is link this field is returned.
content_typestring
Allowed: application/json | text/javascript | text/html
Example: text/html

example

{
  "id": 1,
  "name": "RSS Syndication",
  "meta_title": "",
  "body": "%%Syndicate%%",
  "is_visible": true,
  "parent_id": 0,
  "sort_order": 5,
  "meta_keywords": "0",
  "type": "page",
  "meta_description": "",
  "is_homepage": false,
  "layout_file": "",
  "is_customers_only": false,
  "search_keywords": "0",
  "has_mobile_version": false,
  "feed": "",
  "link": "",
  "mobile_body": "0",
  "url": "/rss-syndication/"
}

Update a Page

PUT https://api.bigcommerce.com/stores/{store_hash}/v2/pages/{id}

⚠️

This endpoint is deprecated.

Request

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

Read Only Fields

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.
Content-Type in header with default of application/json - string - required
The MIME type of the request body.

Body

object | application/json

parent_idinteger
ID of any parent Web page.
Example: 5
typestring
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
contact_fieldsstring
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
emailstring
Where the page’s type is a contact form: email address that receives messages sent via the form.
Example: janedoes@example.com
namestring
required
Page name, as displayed on the storefront.
Example: Contact Form
urlstring
Relative URL on the storefront for this page.
Example: /contact-us/
meta_descriptionstring
Description contained within this page’s <meta/> element.
bodystring
required
HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.
Example: We're happy to answer questions or help you with returns. Please fill out the form below if you need assistance.
mobile_bodystring
HTML to use for this page's body when viewed in the mobile template (deprecated).
Example: 0
has_mobile_versionboolean
If true, this page has a mobile version.
Example: false
is_visibleboolean
If true, this page appears in the storefront’s navigation menu.
Example: true
is_homepageboolean
If true, this page is the storefront’s home page.
Example: false
meta_titlestring
Text specified for this page’s <title> element. (If empty, the value of the name property is used.)
layout_filestring
Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
Example: page.html
sort_orderinteger
Order in which this page should display on the storefront. (Lower integers specify earlier display.)
Example: 3
search_keywordsstring
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
meta_keywordsstring
Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.
feedstring
If page type is rss_feed then this field is visible. Required in POST required for rss page type.
linkstring
If page type is link this field is returned. Required in POST to create a link page.
content_typestring
Allowed: application/json | text/javascript | text/html
Example: text/html

example

{
  "parent_id": 5,
  "type": "page",
  "contact_fields": "fullname,companyname,phone,orderno,rma",
  "email": "janedoes@example.com",
  "name": "Contact Form",
  "url": "/contact-us/",
  "meta_description": "string",
  "body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>",
  "mobile_body": "0",
  "has_mobile_version": false,
  "is_visible": true,
  "is_homepage": false,
  "meta_title": "string",
  "layout_file": "page.html",
  "sort_order": 3,
  "search_keywords": "string",
  "meta_keywords": "string",
  "feed": "string",
  "link": "string",
  "content_type": "text/html"
}

Response

Body

object | application/json

parent_idinteger
ID of any parent Web page.
Example: 5
typestring
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
contact_fieldsstring
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
emailstring
Where the page’s type is a contact form: email address that receives messages sent via the form.
Example: janedoes@example.com
namestring
required
Page name, as displayed on the storefront.
Example: Contact Form
urlstring
Relative URL on the storefront for this page.
Example: /contact-us/
meta_descriptionstring
Description contained within this page’s <meta/> element.
bodystring
required
HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.
Example: We're happy to answer questions or help you with returns. Please fill out the form below if you need assistance.
mobile_bodystring
HTML to use for this page's body when viewed in the mobile template (deprecated).
Example: 0
has_mobile_versionboolean
If true, this page has a mobile version.
Example: false
is_visibleboolean
If true, this page appears in the storefront’s navigation menu.
Example: true
is_homepageboolean
If true, this page is the storefront’s home page.
Example: false
meta_titlestring
Text specified for this page’s <title> element. (If empty, the value of the name property is used.)
layout_filestring
Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
Example: page.html
sort_orderinteger
Order in which this page should display on the storefront. (Lower integers specify earlier display.)
Example: 3
search_keywordsstring
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
meta_keywordsstring
Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.
feedstring
If page type is rss_feed then this field is visible. Required in POST required for rss page type.
linkstring
If page type is link this field is returned. Required in POST to create a link page.
content_typestring
Allowed: application/json | text/javascript | text/html
Example: text/html

example

{
  "id": 2,
  "name": "Shipping & Returns",
  "meta_title": "",
  "body": "<em>To edit this page simply login to the control panel, click the <strong style='font-weight: 400'>Website Content</strong> tab and choose the </em> <strong style='font-weight: 400'><em>View Web Pages option. Click Edit next to the Shipping & Returns page and you can change this text. A sample returns policy is shown below which you can edit as needed.</em><em style='font-style: normal'><br/><br/></em></strong><em style='font-style: normal'><strong>Returns Policy</strong></em><strong style='font-weight: 400'></em></em><em style='font-style: normal'><br/><br/></em>You may return most new, unopened items within 30 days of delivery for a full refund. We'll also pay the return shipping costs if the return is a result of our error (you received an incorrect or defective item, etc.).<br/><br/>You should expect to receive your refund within four weeks of giving your package to the return shipper, however, in many cases you will receive a refund more quickly. This time period includes the transit time for us to receive your return from the shipper (5 to 10 business days), the time it takes us to process your return once we receive it (3 to 5 business days), and the time it takes your bank to process our refund request (5 to 10 business days).<br/><br/>If you need to return an item, please <a href='/contact-us/'>Contact Us</a> with your order number and details about the product you would like to return. We will respond quickly with instructions for how to return items from your order.<br/><br/></strong><strong>Shipping</em></em></em></strong><strong style='font-weight: 400'><em style='font-style: normal'><br/><br/></em>We can ship to virtually any address in the world. Note that there are restrictions on some products, and some products cannot be shipped to international destinations.<br/><br/>When you place an order, we will estimate shipping and delivery dates for you based on the availability of your items and the shipping options you choose. Depending on the shipping provider you choose, shipping date estimates may appear on the shipping quotes page.<br/><br/>Please also note that the shipping rates for many items we sell are weight-based. The weight of any such item can be found on its detail page. To reflect the policies of the shipping companies we use, all weights will be rounded up to the next full pound.<br/>",
  "is_visible": true,
  "parent_id": 0,
  "sort_order": 2,
  "meta_keywords": "",
  "type": "page",
  "meta_description": "",
  "is_homepage": false,
  "layout_file": "page.html",
  "is_customers_only": false,
  "search_keywords": "",
  "has_mobile_version": false,
  "feed": "",
  "link": "",
  "mobile_body": "",
  "url": "/shipping-returns/"
}

Delete a Page

DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/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
Accept in header with default of application/json - string - required
The MIME type of the response body.
id in path - integer - required
ID of the page.

example

curl --request DELETE \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/pages/[id]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Get All Pages

Request

Warning

Authentication

Parameters

example

Response

Body

example

Create a Page

Request

Content Type

Warning

Authentication

Parameters

Body

parent_idinteger

typestringrequired

contact_fieldsstring

emailstring

namestringrequired

urlstring

meta_descriptionstring

bodystringrequired

mobile_bodystring

has_mobile_versionboolean

is_visibleboolean

is_homepageboolean

meta_titlestring

layout_filestring

sort_orderinteger

search_keywordsstring

meta_keywordsstring

feedstring

linkstring

content_typestring

example-1

Response

Body

idinteger

parent_idinteger

typestring

contact_fieldsstring

emailstring

namestring

urlstring

meta_descriptionstring

bodystring

mobile_bodystring

has_mobile_versionboolean

is_visibleboolean

is_homepageboolean

meta_titlestring

layout_filestring

sort_orderinteger

search_keywordsstring

meta_keywordsstring

feedstring

linkstring

content_typestring

example

Get A Page

Request

Warning

Authentication

Parameters

example

Response

Body

idinteger

parent_idinteger

typestring

contact_fieldsstring

emailstring

namestring

urlstring

meta_descriptionstring

bodystring

mobile_bodystring

has_mobile_versionboolean

typestring
required

namestring
required

bodystring
required

typestring
required

namestring
required

bodystring
required

typestring
required

namestring
required

bodystring
required