BigCommerce Pages is a website builder tool that allows users to easily create and customize web pages for their online store. With BigCommerce Pages, users can design landing pages, product pages, and other key pages to enhance the overall user experience and improve conversion rates. The platform provides a user-friendly interface with drag-and-drop functionality, making it easy for users to add text, images, videos, and more to their pages.
openapi: 3.0.3
info:
title: BigCommerce Pages V3
version: ''
termsOfService: http://www.bigcommerce.com/terms
contact:
name: BigCommerce
url: https://www.bigcommerce.com
email: [email protected]
description: >-
## Overview
A **page** appears on a **site** that is associated with a **channel**.
Some pages, such as blog pages, contact forms, and plain-text or HTML pages,
are web pages in the traditional sense. They contain markup (a `body`) and
load at a relative page location on the site itself (the `url`). Other
pages, such as link and feed pages, make external or non-visual content
available from the menu of a parent page or by direct link.
### Bulk operations
All endpoints without a `pageId` path parameter support bulk operations.
### Page types
The following table describes the types of pages that the Pages API can
manage:
| Page Type | Description | Body |
|:-|:|:--|
| `page` | A user-defined plain-text page. | text |
| `contact_form` | A user-customizable page that contains a contact form. |
HTML |
| `raw` | A user-defined page that contains HTML markup or other stringified
code. | HTML, other code |
| `blog` | A page that contains blog posts. Use caution; `blog`-type pages
can only be created in the store control panel, but you may be able to
change the type of a blog page to something else with this API. Use the
[Store Content
API](/docs/rest-content/store-content/blog-posts#create-a-blog-post) to work
with blog posts and tags. | empty string |
| `feed` | Makes RSS-syndicated content feeds available in the menu of other
pages that contain markup. | — |
| `link` | A link to an external absolute URL. Displays in the menu of other
pages that contain markup. | — |
servers:
- url: https://api.bigcommerce.com/stores/{store_hash}/v3
variables:
store_hash:
default: store_hash
description: Permanent ID of the BigCommerce store.
description: BigCommerce API Gateway
tags:
- name: Pages (Bulk)
- name: Pages (Single)
security:
- X-Auth-Token: []
paths:
/content/pages:
get:
operationId: getPages
tags:
- Pages (Bulk)
description: >-
Returns one or more content pages. This endpoint supports bulk
operations.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PagesCollectionResponse'
'400':
description: >-
Bad Request; reasons for failure include passing query parameters
that are not supported on this endpoint, but are common on other
BigCommerce endpoints.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorDetailed'
'422':
description: >-
Invalid input. Reasons for failure include passing supported
parameters with values that have the incorrect datatype.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorItemized'
parameters:
- $ref: '#/components/parameters/channelIdQuery'
- $ref: '#/components/parameters/idInQueryGet'
- $ref: '#/components/parameters/nameQuery'
- $ref: '#/components/parameters/nameLikeQuery'
- $ref: '#/components/parameters/limitQuery'
- $ref: '#/components/parameters/pageQuery'
- $ref: '#/components/parameters/includeQuery'
summary: BigCommerce Get Pages
post:
operationId: createPages
tags:
- Pages (Bulk)
description: >-
Creates one or more content pages. This endpoint supports bulk
operations.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Page'
examples:
example-1:
value:
channel_id: 1
name: Content Page
is_visible: false
parent_id: 0
sort_order: 0
type: page
body: <div>Hello World!</div>
is_homepage: false
meta_title: My Content page
meta_keywords: string
meta_description: string
search_keywords: string
url: /my-content-page
description: ''
required: true
responses:
'201':
$ref: '#/components/responses/HTTP201CreatePages'
'207':
$ref: '#/components/responses/HTTP207Response'
'422':
description: >-
The input was not valid. This is the result of missing required
fields or other invalid arguments. See the response for more
details.
When making bulk requests, an invalid input in any one entry will
cause the whole request to return 422. The entries that are valid
will still be created.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorDetailed'
parameters:
- $ref: '#/components/parameters/includeQuery'
- $ref: '#/components/parameters/ContentType'
summary: BigCommerce Create Pages
put:
operationId: updatePages
tags:
- Pages (Bulk)
description: >-
Updates one or more content pages. This endpoint supports bulk
operations.
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/PagePutBulk'
- type: array
items:
$ref: '#/components/schemas/PagePutBulk'
responses:
'200':
description: |
Updated.
content:
application/json:
schema:
$ref: '#/components/schemas/PagesCollectionResponse'
examples:
update meta descriptions for two pages:
value:
data:
- id: 20
channel_id: 1
name: all about powder detergents
meta_title: ''
is_visible: false
parent_id: 0
sort_order: 0
meta_keywords:
type: page
meta_description: cornpone
is_homepage: false
is_customers_only: false
search_keywords: ''
- id: 19
channel_id: 1
name: sign up to dream big
meta_title: ''
email: ''
is_visible: false
parent_id: 0
sort_order: 0
meta_keywords:
contact_fields: ''
type: contact_form
meta_description: arugula
is_homepage: false
is_customers_only: false
search_keywords: ''
meta: {}
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorBrief'
examples:
example-1:
value:
status: 0
title: string
type: string
'422':
description: >-
The input was not valid. This is the result of missing required
fields or other invalid arguments. See the response for more
details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorDetailed'
examples:
missing required field for type raw:
value:
status: 422
title: Input is invalid
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
detail: 'missing the required field: body'
parameters:
- $ref: '#/components/parameters/includeQuery'
- $ref: '#/components/parameters/ContentType'
summary: BigCommerce Update Pages
delete:
operationId: deletePages
tags:
- Pages (Bulk)
description: >-
Deletes one or more content pages. This endpoint supports bulk
operations.
> #### Warning
> **Pay attention to query parameters**
> If you attempt to delete multiple pages by passing more than one page
ID to `id:in` and one or more of them does not exist, you will receive a
404 response. However, the pages corresponding to the page IDs that do
exist will still be deleted.
responses:
'204':
$ref: '#/components/responses/HTTP204'
'404':
description: >-
Not Found. One of more of the pages specified for deletion did not
exist. Specified pages that did exist were successfully deleted.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorBrief'
examples:
Page not found:
value:
status: 404
title: A Page was not found with an ID of 100
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
'422':
description: Invalid input. See response for details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorDetailed'
examples:
Missing ID:
value:
status: 422
title: Input is invalid
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
detail: 'missing the required field: id'
parameters:
- $ref: '#/components/parameters/idInQueryDelete'
summary: BigCommerce Delete Pages
parameters:
- $ref: '#/components/parameters/Accept'
/content/pages/{pageId}:
get:
operationId: getPage
tags:
- Pages (Single)
description: >-
Returns one content page.
> #### Warning
> **Pay attention to query parameters**
> This endpoint recognizes the same query parameters as [Get Multiple
Pages](/docs/rest-content/pages#get-pages). If the requested page does
not meet the query parameters you specify, you will receive a 404
response even if the requested `pageId` does exist.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PageResponse'
examples:
several data types:
value:
data:
- id: 3
channel_id: 1
name: Blog
meta_title: Blog
is_visible: false
parent_id: 0
sort_order: 4
meta_keywords: ''
type: blog
meta_description: ''
is_homepage: false
is_customers_only: false
search_keywords: '0'
url: /blog/
- id: 5
channel_id: 1
name: Contact Us
meta_title: ''
email: ''
is_visible: true
parent_id: 0
sort_order: 3
meta_keywords: contact keyword
contact_fields: fullname,companyname,phone,orderno,rma
type: contact_form
meta_description: contact meta desc
is_homepage: false
is_customers_only: true
search_keywords: contact search keyword
- id: 16
channel_id: 1
name: all about powder detergents 2
meta_title: ''
is_visible: false
parent_id: 0
sort_order: 0
meta_keywords:
type: page
meta_description: ''
is_homepage: false
is_customers_only: false
search_keywords: ''
- id: 17
channel_id: 1
name: one hundred million red balloons 3
is_visible: false
parent_id: 0
sort_order: 0
type: raw
is_homepage: false
is_customers_only: false
search_keywords: ''
content_type: text/html
- id: 18
channel_id: 1
name: diaper pin purveyors 3
is_visible: false
parent_id: 0
sort_order: 0
link: https://example.com/diaper-pins
type: link
is_homepage: false
is_customers_only: false
- id: 19
channel_id: 1
name: sign up to crush dreams 3
meta_title: ''
email: ''
is_visible: false
parent_id: 0
sort_order: 0
meta_keywords:
contact_fields: ''
type: contact_form
meta_description: ''
is_homepage: false
is_customers_only: false
search_keywords: ''
- id: 20
channel_id: 1
name: all about powder detergents 3
meta_title: ''
is_visible: false
parent_id: 0
sort_order: 0
meta_keywords:
type: page
meta_description: ''
is_homepage: false
is_customers_only: false
search_keywords: ''
- id: 21
channel_id: 1
name: feed monsters 3
meta_title: ''
is_visible: false
parent_id: 0
sort_order: 0
meta_keywords:
feed: /rss/monsters
type: feed
meta_description: ''
is_homepage: false
is_customers_only: false
search_keywords: ''
- id: 22
channel_id: 1
name: one hundred million red balloons 4
is_visible: false
parent_id: 0
sort_order: 0
type: raw
is_homepage: false
is_customers_only: false
search_keywords: ''
content_type: text/html
- id: 23
channel_id: 1
name: diaper pin purveyors 4
is_visible: false
parent_id: 0
sort_order: 0
link: https://example.com/diaper-pins
type: link
is_homepage: false
is_customers_only: false
meta:
pagination:
total: 6
count: 6
per_page: 50
current_page: 1
total_pages: 1
links:
current: '?page=1&limit=50'
'404':
description: Not Found.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorBrief'
examples:
pageId does not exist:
value:
status: 404
title: A Page was not found with an ID of 99
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
'422':
description: >-
Invalid input. One or more path parameter(s) did not have the
correct datatype.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorItemized'
examples:
pageId is bar:
value:
status: 422
title: Invalid Input.
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
errors:
- bar
parameters:
- $ref: '#/components/parameters/includeQuery'
summary: BigCommerce Get a Page
put:
operationId: updatePage
tags:
- Pages (Single)
description: Updates one content page.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PagePut'
description: ''
required: true
responses:
'200':
description: |2+
content:
application/json:
schema:
$ref: '#/components/schemas/PageResponse'
'400':
description: >-
Bad Request; reasons for failure include invalid query parameters.
See the response for more details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorDetailed'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorBrief'
examples:
not found:
value:
status: 404
title: A Page was not found with an ID of 99
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
'422':
description: >-
The input was not valid. This error is the result of missing
required fields or other invalid arguments. See the response for
more details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorDetailed'
parameters:
- $ref: '#/components/parameters/ContentType'
- $ref: '#/components/parameters/includeQuery'
summary: BigCommerce Update a Page
delete:
operationId: deletePage
tags:
- Pages (Single)
description: |-
Deletes one content page.
> #### Warning
> **Query parameters not recognized**
> This endpoint does not recognize query parameters.
responses:
'204':
$ref: '#/components/responses/HTTP204'
'404':
description: The page specified for deletion did not exist.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ResponseErrorBrief'
examples:
example-1:
value:
status: 404
title: A Page was not found with an ID of 99
type: >-
https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes
parameters: []
summary: BigCommerce Delete a Page
parameters:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/pageIdPath'
components:
parameters:
Accept:
name: Accept
in: header
required: true
schema:
type: string
default: application/json
ContentType:
name: Content-Type
in: header
required: true
schema:
type: string
default: application/json
storeHashPath:
schema:
type: string
name: store_hash
in: path
required: true
description: The permanent ID of the BigCommerce store.
pageIdPath:
schema:
type: string
name: pageId
in: path
required: true
description: The ID of the page to be operated on.
includeQuery:
schema:
type: string
enum:
- body
in: query
name: include
description: >-
Include the requested property in the response. The `body` property
returns the page’s markup, text, or raw content.
channelIdQuery:
schema:
type: integer
in: query
name: channel_id
description: Return only pages associated with the specified channel.
idInQueryGet:
schema:
type: string
in: query
name: id:in
description: >-
A comma-separated string of page IDs to fetch. Supports bulk operations.
If none of the page IDs passed exist, the query will return an empty
`data` array.
idInQueryDelete:
schema:
type: string
in: query
name: id:in
description: >-
Request deletion of multiple pages by passing a comma-separated string
of corresponding page IDs. Supports bulk operations.
required: true
nameQuery:
schema:
type: string
in: query
name: name
description: Name of the page.
nameLikeQuery:
schema:
type: string
in: query
name: name:like
description: Return only pages whose `name` or `body` contain the supplied string.
limitQuery:
schema:
type: integer
in: query
name: limit
description: >-
The number of results to return per request. See
`meta.pagination.per_page` in the response body.
pageQuery:
schema:
type: integer
in: query
name: page
description: >-
The ordered grouping of results to return. See
`meta.pagination.current_page` in the response body.
headers:
Content-Type:
description: >-
The [MIME
type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)
of the request body.
schema:
type: string
default: application/json
Accept:
description: >-
The [MIME
type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)
of the response body.
schema:
type: string
default: application/json
X-Auth-Token:
description: Your API account's access token.
schema:
type: string
securitySchemes:
X-Auth-Token:
type: apiKey
name: X-Auth-Token
in: header
description: >-
## API account
You can use this API with a [store API account or an app API
account](https://developer.bigcommerce.com/api-docs/getting-started/rest-api-authentication).
## OAuth scopes
| UI Name | Permission | Parameter |
|:--|:--|:-|
| Content | modify |`store_v2_content`|
| Content | read-only |`store_v2_content_read_only`|
For a [full list of OAuth
scopes](https://developer.bigcommerce.com/api-docs/getting-started/rest-api-authentication#oauth-scopes),
see our narrative documentation.
## Security header
Include a header parameter called `X-Auth-Token` and pass it the
`access_token` provided with your store API account or generated with
your app's `/auth` callback.
```http filename="Security header example"
X-Auth-Token: example_access_token
```
## Example requests
For detailed examples, consult our [X-Auth-Token example
requests](https://developer.bigcommerce.com/api-docs/getting-started/authentication#x-auth-token-header-example-requests).
## Additional information
[BigCommerce Terms of Service](http://www.bigcommerce.com/terms)
schemas:
ResponseErrorBrief:
type: object
description: |
Error payload for the BigCommerce API.
properties:
status:
description: |
The HTTP status code.
type: integer
title:
description: |
The error title describing the particular error.
type: string
type:
type: string
required:
- status
ResponseErrorDetailed:
type: object
description: |
Error payload for the BigCommerce API.
properties:
status:
description: |
The HTTP status code.
type: integer
title:
description: |
The error title describing the particular error.
type: string
type:
type: string
detail:
type: string
required:
- status
ResponseErrorItemized:
type: object
description: |
Error payload for the BigCommerce API.
title: ResponseErrorItemized
properties:
status:
description: |
The HTTP status code.
type: integer
title:
description: |
The error title describing the particular error.
type: string
type:
type: string
errors:
type: array
items:
type: string
required:
- status
ResponseMeta:
type: object
description: |
Data about the response, including pagination and collection totals.
properties:
pagination:
type: object
description: |
Data about the response, including pagination and collection totals.
properties:
total:
type: integer
description: |
Total number of items in the result set.
count:
type: integer
description: |
Total number of items in the collection response.
per_page:
type: integer
description: >
The amount of items returned in the collection per page,
controlled by the limit parameter.
current_page:
type: integer
description: |
The page you are currently on within the collection.
total_pages:
type: integer
description: |
The total number of pages in the collection.
links:
type: object
description: >
Pagination links for the previous and next parts of the whole
collection.
properties:
previous:
type: string
description: |
Link to the previous page returned in the response.
current:
type: string
description: |
Link to the current page returned in the response.
next:
type: string
description: |
Link to the next page returned in the response.
PagesCollectionResponse:
description: |
Response payload for the BigCommerce API.
type: object
title: ''
properties:
data:
type: array
items:
anyOf:
- $ref: '#/components/schemas/typePage'
- $ref: '#/components/schemas/typeBlog'
- $ref: '#/components/schemas/typeContactForm'
- $ref: '#/components/schemas/typeFeed'
- $ref: '#/components/schemas/typeRaw'
- $ref: '#/components/schemas/typeLink'
meta:
$ref: '#/components/schemas/ResponseMeta'
PageResponse:
description: |
Response payload for the BigCommerce API.
x-examples: {}
allOf:
- properties:
data:
type: object
items:
$ref: '#/components/schemas/Page'
meta:
$ref: '#/components/schemas/ResponseMeta'
title: PageResponseObject
type: object
ContactFields:
allOf:
- properties:
fullname:
type: string
description: Full name of the customer who is submitting the form.
phone:
type: string
description: Customer’s phone number, as submitted on the form.
companyname:
type: string
description: Customer’s submitted company name.
orderno:
type: string
description: Customer’s submitted order number.
rma:
type: string
description: >-
Customer’s submitted RMA (Return Merchandise Authorization)
number.
type: object
PagePutBulk:
type: object
description: Properties of the page modification request body.
properties:
name:
type: string
description: |
The name of the page. Must be unique.
minLength: 1
maxLength: 100
example: My Store Page
is_visible:
type: boolean
description: >
Boolean value that specifies the visibility of the page in the
storefront’s navigation menu.
Indicates whether the page is available to users and visible in any
menus.
parent_id:
type: integer
description: |
ID of any parent Web page.
example: 0
default: 0
sort_order:
type: integer
description: >
Specifies the order in which the page is displayed on the
storefront. (Lower integers specify earlier display.)
example: 0
default: 0
type:
type: string
description: >-
Specifies the type of the page. The following values are possible;
|Value|Description|
|-|-|
| `blog` | blog page. Read-only; blog pages can only be created in
the store control panel. |
|`contact_form`|hosts the store's contact form|
|`link`|link to another absolute URL|
|`page`|user-defined plain-text page|
|`raw`|page that contains markup, such as HTML.|
|`rss_feed`|contains syndicated content from an RSS feed|
example: page
enum:
- page
- raw
- contact_form
- feed
- link
- blog
is_homepage:
type: boolean
description: >
Boolean value that specifies whether this page is the storefront’s
home page
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/pages-openapi-original.yml