openapi: 3.0.1
info:
title: BigCommerce Content
description: >-
Manage blog posts, blog tags, content pages, and redirects.
> #### Warning
> **Deprecations**
> * Redirects V2 are deprecated; use [Redirects
V3](/docs/rest-management/redirects) instead.
> * Pages V2 are deprecated; use [Pages V3](/docs/rest-content/pages)
instead.
version: ''
termsOfService: https://www.bigcommerce.com/terms
contact:
name: BigCommerce
url: https://www.bigcommerce.com
email: [email protected]
servers:
- url: https://api.bigcommerce.com/stores/{store_hash}/v2
variables:
store_hash:
default: store_hash
description: Permanent ID of the BigCommerce store.
description: BigCommerce API Gateway
security:
- X-Auth-Token: []
tags:
- name: Blog Posts
- name: Blog Tags
- name: Pages
- name: Redirects
paths:
/blog/tags:
parameters:
- $ref: '#/components/parameters/Accept'
get:
tags:
- Blog Tags
summary: BigCommerce Get All Blog Tags
description: Returns a list of *Blog Tags*.
operationId: getBlogTags
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/blogTags'
/blog/posts:
parameters:
- $ref: '#/components/parameters/Accept'
get:
tags:
- Blog Posts
summary: BigCommerce Get All Blog Posts
description: >-
Returns all *Blog Posts*. Default sorting is by published_date,
beginning with the most recent post.
operationId: getBlogPosts
parameters:
- name: is_published
in: query
description: Filter param.
schema:
type: boolean
- name: url
in: query
description: Filter param. Value must be URL encoded.
schema:
type: string
- name: tag
in: query
description: Filter param.
schema:
type: string
- name: published_date
in: query
description: Filter param.
schema:
type: string
format: date-time
- name: page
in: query
description: Filter param.
schema:
maximum: 50
exclusiveMinimum: false
type: integer
- name: limit
in: query
description: Filter param.
schema:
maximum: 250
exclusiveMaximum: false
exclusiveMinimum: false
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/blogPost_Full'
example:
- id: 3
title: Hello Again
url: /blog/hello-again/
preview_url: /blog/hello-again/
body: >-
<p>Jelly beans muffin marzipan gingerbread donut dessert.
Cheesecake cheesecake sugar plum cookie cake tart. Soufflé
sesame snaps jelly beans brownie chocolate tart. Marshmallow
jujubes candy pie. Gummies lemon drops tart soufflé pastry
pie. Caramels wafer biscuit gummi bears. Liquorice toffee
wafer bear claw marzipan jelly-o. Dessert bear claw topping
icing croissant. Pie bonbon chocolate bar chocolate bar
tiramisu chocolate lemon drops candy.</p><p>Marshmallow
cupcake sweet roll candy marshmallow caramels cotton candy
pie icing. Powder jelly beans chupa chups lollipop liquorice
marzipan dessert soufflé sesame snaps. Macaroon chupa chups
gummies cheesecake ice cream caramels sesame snaps cotton
candy gingerbread. Chocolate cake fruitcake tart bear claw
lemon drops tart dragée tart apple pie. Halvah chupa chups
soufflé jelly soufflé marshmallow. Croissant tart tart.
Gingerbread apple pie biscuit.</p><p>Wafer lemon drops tart
pastry brownie chocolate bar jelly. Dragée muffin cupcake
liquorice caramels marzipan gingerbread marzipan. Apple pie
pudding jelly sweet roll croissant bonbon wafer. Cookie
chocolate bar sesame snaps bonbon macaroon candy canes donut
sugar plum. Bear claw bonbon tootsie roll bonbon. Apple pie
gummies donut sweet. Marzipan bear claw cotton candy topping
dragée bonbon danish powder.</p>
tags:
- sugar
- sweet
- spice
- everything
- nice
summary: >-
Jelly beans muffin marzipan gingerbread donut dessert.
Cheesecake cheesecake sugar plum cookie cake tart. Soufflé
sesame snaps jelly beans brownie chocolate tart. Marshmallow
jujubes candy pie. Gummies lemon drops tart soufflé pastry
pie. Caramels wafer biscuit gummi bears. Liquorice toffee
wafer bear claw marzipan jelly-o. Dessert bear claw topping
icing croissant. Pie bonbon chocolate bar [...]
is_published: true
published_date:
date: '2018-05-18 08:26:42.000000'
timezone_type: 1
timezone: '+00:00'
published_date_iso8601: 2018-05-18T13:26:42+0000
meta_description: Cupcakes post 2
meta_keywords: sugar,sweet,spice,everything,nice
author: ''
thumbnail_path: ''
- id: 2
title: Hello
url: /blog/hello/
preview_url: /blog/hello/
body: >-
<p>Jelly beans muffin marzipan gingerbread donut dessert.
Cheesecake cheesecake sugar plum cookie cake tart. Soufflé
sesame snaps jelly beans brownie chocolate tart. Marshmallow
jujubes candy pie. Gummies lemon drops tart soufflé pastry
pie. Caramels wafer biscuit gummi bears. Liquorice toffee
wafer bear claw marzipan jelly-o. Dessert bear claw topping
icing croissant. Pie bonbon chocolate bar chocolate bar
tiramisu chocolate lemon drops candy.</p><p>Marshmallow
cupcake sweet roll candy marshmallow caramels cotton candy
pie icing. Powder jelly beans chupa chups lollipop liquorice
marzipan dessert soufflé sesame snaps. Macaroon chupa chups
gummies cheesecake ice cream caramels sesame snaps cotton
candy gingerbread. Chocolate cake fruitcake tart bear claw
lemon drops tart dragée tart apple pie. Halvah chupa chups
soufflé jelly soufflé marshmallow. Croissant tart tart.
Gingerbread apple pie biscuit.</p><p>Wafer lemon drops tart
pastry brownie chocolate bar jelly. Dragée muffin cupcake
liquorice caramels marzipan gingerbread marzipan. Apple pie
pudding jelly sweet roll croissant bonbon wafer. Cookie
chocolate bar sesame snaps bonbon macaroon candy canes donut
sugar plum. Bear claw bonbon tootsie roll bonbon. Apple pie
gummies donut sweet. Marzipan bear claw cotton candy topping
dragée bonbon danish powder.</p>
tags:
- cupcakes
- sugar
- sweet
summary: >-
Jelly beans muffin marzipan gingerbread donut dessert.
Cheesecake cheesecake sugar plum cookie cake tart. Soufflé
sesame snaps jelly beans brownie chocolate tart. Marshmallow
jujubes candy pie. Gummies lemon drops tart soufflé pastry
pie. Caramels wafer biscuit gummi bears. Liquorice toffee
wafer bear claw marzipan jelly-o. Dessert bear claw topping
icing croissant. Pie bonbon chocolate bar [...]
is_published: true
published_date:
date: '2018-05-18 08:26:00.000000'
timezone_type: 1
timezone: '+00:00'
published_date_iso8601: 2018-05-18T13:26:00+0000
meta_description: cupcake blog post
meta_keywords: cupcakes,sugar,sweet
author: ''
thumbnail_path: ''
- id: 1
title: Your first blog post!
url: /your-first-blog-post/
preview_url: /your-first-blog-post/
body: >-
<p><strong>Welcome to your blog!</strong><br> A blog is a
great place to share details on your products, business and
whatever else you think your shoppers might like to hear
from you. You can include photos in your blog posts and even
videos. For ideas and inspiration on how to structure your
blog, take a look at the BigCommerce <a
href='http://blog.bigcommerce.com/' target='_blank'
rel='nofollow'>ecommerce blog</a>.</p><p><strong>How can I
delete this post?</strong><br>To delete this post and add
your own, login to your <a href='/admin'
target='_blank'>admin area</a> and go to Storefront > Blog
in the left hand menu.</p><p><strong>Powered by
BigCommerce</strong><br>Your website, online store and blog
are powered by BigCommerce <a
href='http://www.bigcommerce.com/' target='_blank'
rel='nofollow'>ecommerce software</a>. It includes
everything you need to run a beautiful online store
including <a href='http://www.bigcommerce.com/templates/'
target='_blank' rel='nofollow'>ecommerce website
templates</a>, <a
href='http://www.bigcommerce.com/features/hosting/'
target='_blank' rel='nofollow'>ecommerce hosting</a>, an <a
href='http://www.bigcommerce.com/features/setup/'
target='_blank' rel='nofollow'>online shopping cart</a> and
more.</p>
tags:
- Blog
- SEO
summary: ' Welcome to your blog! A blog is a great place to share details on your products, business and whatever else you think your shoppers might like to hear from you. You can include photos in your blog posts and even videos. For ideas and inspiration on how to structure your blog, take a look [...]'
is_published: true
published_date:
date: '2014-02-15 14:46:34.000000'
timezone_type: 1
timezone: '+00:00'
published_date_iso8601: 2014-02-15T19:46:34+0000
meta_description: ''
meta_keywords: Blog,SEO
author: ''
thumbnail_path: ''
post:
tags:
- Blog Posts
summary: BigCommerce Create a Blog Post
description: >-
Creates a *Blog Post*.
**Required Fields**
* `title`
* `body`
**Notes**
* When including `published_date` in a request, supply it as a flat date
string (not an object) in valid <a
href="http://tools.ietf.org/html/rfc2822#section-3.3"
target="_blank">RFC 2822</a>. The following example request includes a
`published_date` in RFC 2822 format.
* Blog posts default to draft status. To publish blog posts to the
storefront, set the `is_published` property to `true`.
* If a custom URL is not provided, the post’s URL will be generated
based on the value of `title`.
operationId: createBlogPosts
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/blogPost_Base_Post'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/blogPost_Base_Res'
example:
id: 3
title: Welcome to BigCommerce
url: /blog/welcome-bigcommerce/
preview_url: /blog/welcome-bigcommerce/
body: >-
<p>Customize your site, manage shipping and payments, and list
your products on Amazon, eBay, and Facebook by Meta with the
#1 ecommerce platform. </p>
tags:
- BigCommerce
- welcome
- ecommerce
summary: >-
<p>We power ecommerce websites for successful retailers all
over the world</p>
is_published: true
published_date:
date: '2018-05-18T08:26:42.000Z'
timezone_type: 1
timezone: '+00:00'
published_date_iso8601: '2018-05-18T13:26:42.000Z'
meta_description: Welcome Post
meta_keywords: BigCommerce, welcome, ecommerce
author: BigCommerce
thumbnail_path: ''
'207':
description: >-
Multiple operations have taken place and the status for each
operation can be viewed in the body of the response. Typically
indicates that a partial failure has occured, such as when a `POST`
or `PUT` request is successful, but saving the URL has failed.
content:
application/json:
schema:
type: object
delete:
tags:
- Blog Posts
summary: BigCommerce Delete Blog Posts
description: Deletes a page of `Blog Posts`.
operationId: deleteBlogPosts
parameters:
- name: page
in: query
description: Filter param.
schema:
maximum: 250
exclusiveMaximum: false
exclusiveMinimum: false
type: integer
- name: limit
in: query
description: Filter param.
schema:
maximum: 50
exclusiveMaximum: false
exclusiveMinimum: false
type: integer
responses:
'204':
description: ''
content: {}
/blog/posts/{id}:
parameters:
- $ref: '#/components/parameters/Accept'
- name: id
in: path
description: ID of the blog post.
required: true
schema:
exclusiveMaximum: false
exclusiveMinimum: false
type: integer
get:
tags:
- Blog Posts
summary: BigCommerce Get a Blog Post
description: Returns a single *Blog Post*.
operationId: getBlogPost
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/blogPost_Full'
example:
id: 3
title: Welcome to BigCommerce
url: /blog/welcome-bigcommerce/
preview_url: /blog/welcome-bigcommerce/
body: >-
<p>Customize your site, manage shipping and payments, and list
your products on Amazon, eBay, and Facebook by Meta with the
#1 ecommerce platform. </p>
tags:
- BigCommerce
- welcome
- ecommerce
summary: >-
<p>We power ecommerce websites for successful retailers all
over the world</p>
is_published: true
published_date:
date: '2018-05-18T08:26:42.000Z'
timezone_type: 1
timezone: '+00:00'
published_date_iso8601: '2018-05-18T13:26:42.000Z'
meta_description: Welcome Post
meta_keywords: BigCommerce, welcome, ecommerce
author: BigCommerce
thumbnail_path: ''
put:
tags:
- Blog Posts
summary: BigCommerce Update a Blog Post
description: >-
Updates a *Blog Post*.
**Notes**
* To include `published_date` in a request, provide a flat date string
(not an object) in valid <a
href="http://tools.ietf.org/html/rfc2822#section-3.3"
target="_blank">RFC 2822</a>. The following example request includes a
`published_date` in RFC 2822 format.
* Blog posts default to draft status. To publish blog posts to the
storefront, set the `is_published` property to `true`.
operationId: updateBlogPost
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/blogPost_Base_Post'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/blogPost_Base_Res'
example:
id: 3
title: Welcome to BigCommerce
url: /blog/welcome-bigcommerce/
preview_url: /blog/welcome-bigcommerce/
body: >-
<p>Customize your site, manage shipping and payments, and list
your products on Amazon, eBay, and Facebook by Meta with the
#1 ecommerce platform. </p>
tags:
- BigCommerce
- welcome
- ecommerce
summary: >-
<p>We power ecommerce websites for successful retailers all
over the world</p>
is_published: true
published_date:
date: '2018-05-18T08:26:42.000Z'
timezone_type: 1
timezone: '+00:00'
published_date_iso8601: '2018-05-18T13:26:42.000Z'
meta_description: Welcome Post
meta_keywords: BigCommerce, welcome, ecommerce
author: BigCommerce
thumbnail_path: ''
'207':
description: >-
Multiple operations have taken place and the status for each
operation can be viewed in the body of the response. Typically
indicates that a partial failure has occurred, such as when a `POST`
or `PUT` request is successful, but saving the URL has failed.
content:
application/json:
schema:
type: object
delete:
tags:
- Blog Posts
summary: BigCommerce Delete a Blog Post
description: Deletes a *Blog Post*.
operationId: deleteBlogPost
responses:
'204':
description: ''
content: {}
/blog/posts/count:
parameters:
- $ref: '#/components/parameters/Accept'
get:
tags:
- Blog Posts
summary: BigCommerce Get A Count of All Blog Posts
description: Returns a count of all *Blog Posts*.
operationId: getBlogPostsCount
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/count_Response'
example:
count: 27
/pages:
parameters:
- $ref: '#/components/parameters/Accept'
get:
deprecated: true
tags:
- Pages
summary: BigCommerce Get All Pages
description: >
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](/docs/rest-content/pages#get-pages) endpoint. To get a single
page, use Pages V3ʼs [Get a page](/docs/rest-content/pages#get-a-page)
endpoint.
operationId: getPages
parameters:
- name: page
in: query
description: Filter param.
schema:
exclusiveMaximum: false
exclusiveMinimum: false
type: number
- name: limit
in: query
description: Filter param.
schema:
exclusiveMaximum: false
exclusiveMinimum: false
type: number
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/page_Full'
Example:
example:
- id: 6
parent_id: 5
type: page
contact_fields: fullname,companyname,phone,orderno,rma
email: [email protected]
name: Contact Form
url: /contact-us/
meta_description: ''
body: We are happy to answer questions or help you with...
mobile_body: ''
feed: ''
link: ''
has_mobile_version: false
is_visible: true
is_homepage: false
layout_file: page.html
sort_order: 3
meta_title: ''
search_keywords: ''
meta_keywords: ''
post:
deprecated: true
tags:
- Pages
summary: BigCommerce Create a Page
description: >-
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](/docs/rest-content/pages#create-pages) endpoint.
operationId: createPage
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/page_Base'
example:
parent_id: 5
type: page
contact_fields: fullname,companyname,phone,orderno,rma
email: [email protected]
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
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/page_Full'
example:
id: 6
parent_id: 5
type: page
contact_fields: fullname,companyname,phone,orderno,rma
email: [email protected]
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: ''
'207':
description: >-
Multiple operations have taken place and the status for each
operation can be viewed in the body of the response. Typically
indicates that a partial failure has occurred, such as when a `POST`
or `PUT` request is successful, but saving the URL has failed.
content:
application/json:
schema:
type: object
/pages/{id}:
parameters:
- $ref: '#/components/parameters/Accept'
- name: id
in: path
description: ID of the page.
required: true
schema:
exclusiveMaximum: false
exclusiveMinimum: false
type: integer
get:
deprecated: true
tags:
- Pages
summary: BigCommerce Get A Page
description: >
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](/docs/rest-content/pages#get-a-page) endpoint.
operationId: getPage
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/page_Full'
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/
put:
deprecated: true
tags:
- Pages
summary: BigCommerce Update a Page
description: >-
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](/docs/rest-content/pages#update-pages) endpoint. To update a
single page, use Pages V3ʼs [Update a
page](/docs/rest-content/pages#update-a-page) endpoint.
operationId: updatePage
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/page_Full'
required: false
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/page_Full'
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: ''
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/content-openapi-original.yml