Blog Posts

Get All Blog Posts

GET https://api.bigcommerce.com/stores/{store_hash}/v2/blog/posts

Request

Returns all Blog Posts. Default sorting is by published_date, beginning with the most recent post.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
The MIME type of the response body.
is_published in query - boolean
Filter param.
url in query - string
Filter param. Value must be URL encoded.
tag in query - string
Filter param.
published_date in query - string
Filter param.
page in query - integer
Filter param.
limit in query - integer
Filter param.

example

Response

Body

array | application/json

idinteger
read-only
ID of this blog post. READ-ONLY.
Example: 3
titlestring
Title of this blog post.
Example: Welcome to BigCommerce
urlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/
preview_urlstring
read-only
URL to preview the blog post. READ-ONLY.
Example: /blog/welcome-bigcommerce/
bodystring
Text body of the blog post.
Example: Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
tagsarray[string]
Tags to characterize the blog post.
summarystring
read-only
Summary of the blog post. READ-ONLY.
Example: We power ecommerce websites for successful retailers all over the world
is_publishedboolean
Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
Example: true
Default: false
published_dateobject
published_date_iso8601string
Published date in ISO 8601 format.
Example: 5/18/2023 1:26:42 PM
meta_descriptionstring or null
Description text for this blog post’s <meta/> element.
Example: Welcome Post
meta_keywordsstring or null
Keywords for this blog post’s <meta/> element.
Example: BigCommerce, welcome, ecommerce
authorstring or null
Name of the blog post’s author.
Example: BigCommerce
thumbnail_pathstring or null
Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Create a Blog Post

POST https://api.bigcommerce.com/stores/{store_hash}/v2/blog/posts

Request

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 RFC 2822. 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.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
The MIME type of the response body.
Content-Type in header with default of application/json - string
required
The MIME type of the request body.

Body

object | application/json

blogPost base for POST requests

titlestring
required
Title of this blog post.
Example: Welcome to BigCommerce
urlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/
bodystring
required
Text body of the blog post.
Example: Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
tagsarray[string]
Tags to characterize the blog post.
is_publishedboolean
Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
Example: true
Default: false
meta_descriptionstring
Description text for this blog post’s <meta/> element.
Example: Welcome Post
meta_keywordsstring
Keywords for this blog post’s <meta/> element.
Example: BigCommerce, welcome, ecommerce
authorstring
Name of the blog post’s author.
Example: BigCommerce
thumbnail_pathstring
Local path to a thumbnail uploaded to /product_images/ using WebDAV.
published_datestring
Example: Wed, 10 Aug 2022 15:39:15 -0500

example

Response

Body

object | application/json

blog post base response

titlestring
Title of this blog post.
Example: Welcome to BigCommerce
urlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/
preview_urlstring
read-only
URL to preview the blog post. READ-ONLY.
Example: /blog/welcome-bigcommerce/
bodystring
Text body of the blog post.
Example: Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
tagsarray[string]
Tags to characterize the blog post.
summarystring
read-only
Summary of the blog post. READ-ONLY.
Example: We power ecommerce websites for successful retailers all over the world
is_publishedboolean
Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
Example: true
Default: false
published_dateobject
published_date_iso8601string
Published date in ISO 8601 format.
Example: 5/18/2023 1:26:42 PM
meta_descriptionstring or null
Description text for this blog post’s <meta/> element.
Example: Welcome Post
meta_keywordsstring or null
Keywords for this blog post’s <meta/> element.
Example: BigCommerce, welcome, ecommerce
authorstring or null
Name of the blog post’s author.
Example: BigCommerce
thumbnail_pathstring or null
Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Delete Blog Posts

DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/blog/posts

Request

Deletes a page of Blog Posts.

Authentication

X-Auth-Token in header

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 - integer
Filter param.
limit in query - integer
Filter param.

example

Response

Get a Blog Post

GET https://api.bigcommerce.com/stores/{store_hash}/v2/blog/posts/{id}

Request

Returns a single Blog Post.

Authentication

X-Auth-Token in header

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 blog post.

example

Response

Body

object | application/json

blog post base response

idinteger
read-only
ID of this blog post. READ-ONLY.
Example: 3
titlestring
Title of this blog post.
Example: Welcome to BigCommerce
urlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/
preview_urlstring
read-only
URL to preview the blog post. READ-ONLY.
Example: /blog/welcome-bigcommerce/
bodystring
Text body of the blog post.
Example: Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
tagsarray[string]
Tags to characterize the blog post.
summarystring
read-only
Summary of the blog post. READ-ONLY.
Example: We power ecommerce websites for successful retailers all over the world
is_publishedboolean
Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
Example: true
Default: false
published_dateobject
published_date_iso8601string
Published date in ISO 8601 format.
Example: 5/18/2023 1:26:42 PM
meta_descriptionstring or null
Description text for this blog post’s <meta/> element.
Example: Welcome Post
meta_keywordsstring or null
Keywords for this blog post’s <meta/> element.
Example: BigCommerce, welcome, ecommerce
authorstring or null
Name of the blog post’s author.
Example: BigCommerce
thumbnail_pathstring or null
Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Update a Blog Post

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

Request

Updates a Blog Post.

Notes

To include published_date in a request, provide a flat date string (not an object) in valid RFC 2822. 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.

Authentication

X-Auth-Token in header

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

Body

object | application/json

blogPost base for POST requests

titlestring
required
Title of this blog post.
Example: Welcome to BigCommerce
urlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/
bodystring
required
Text body of the blog post.
Example: Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
tagsarray[string]
Tags to characterize the blog post.
is_publishedboolean
Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
Example: true
Default: false
meta_descriptionstring
Description text for this blog post’s <meta/> element.
Example: Welcome Post
meta_keywordsstring
Keywords for this blog post’s <meta/> element.
Example: BigCommerce, welcome, ecommerce
authorstring
Name of the blog post’s author.
Example: BigCommerce
thumbnail_pathstring
Local path to a thumbnail uploaded to /product_images/ using WebDAV.
published_datestring
Example: Wed, 10 Aug 2022 15:39:15 -0500

example

Response

Body

object | application/json

blog post base response

titlestring
Title of this blog post.
Example: Welcome to BigCommerce
urlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/
preview_urlstring
read-only
URL to preview the blog post. READ-ONLY.
Example: /blog/welcome-bigcommerce/
bodystring
Text body of the blog post.
Example: Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
tagsarray[string]
Tags to characterize the blog post.
summarystring
read-only
Summary of the blog post. READ-ONLY.
Example: We power ecommerce websites for successful retailers all over the world
is_publishedboolean
Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
Example: true
Default: false
published_dateobject
published_date_iso8601string
Published date in ISO 8601 format.
Example: 5/18/2023 1:26:42 PM
meta_descriptionstring or null
Description text for this blog post’s <meta/> element.
Example: Welcome Post
meta_keywordsstring or null
Keywords for this blog post’s <meta/> element.
Example: BigCommerce, welcome, ecommerce
authorstring or null
Name of the blog post’s author.
Example: BigCommerce
thumbnail_pathstring or null
Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Delete a Blog Post

DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/blog/posts/{id}

Request

Deletes a Blog Post.

Authentication

X-Auth-Token in header

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 blog post.

example

Response

Get A Count of All Blog Posts

GET https://api.bigcommerce.com/stores/{store_hash}/v2/blog/posts/count

Request

Returns a count of all Blog Posts.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
The MIME type of the response body.

example

Response

Body

object | application/json

countnumber
Example: 27

example

Did you find what you were looking for?

Store content Get All Blog Posts

Blog Posts

Get All Blog Posts

Request

Authentication

Parameters

example

Response

Body

idintegerread-only

titlestring

urlstring

preview_urlstringread-only

bodystring

tagsarray[string]

summarystringread-only

is_publishedboolean

published_dateobject

published_date_iso8601string

meta_descriptionstring or null

meta_keywordsstring or null

authorstring or null

thumbnail_pathstring or null

example

Create a Blog Post

Request

Authentication

Parameters

Body

titlestringrequired

urlstring

bodystringrequired

tagsarray[string]

is_publishedboolean

meta_descriptionstring

meta_keywordsstring

authorstring

thumbnail_pathstring

published_datestring

example

Response

Body

titlestring

urlstring

preview_urlstringread-only

bodystring

tagsarray[string]

summarystringread-only

is_publishedboolean

published_dateobject

published_date_iso8601string

meta_descriptionstring or null

meta_keywordsstring or null

authorstring or null

thumbnail_pathstring or null

example

Delete Blog Posts

Request

Authentication

Parameters

example

Response

Get a Blog Post

Request

Authentication

Parameters

example

Response

Body

idintegerread-only

titlestring

urlstring

preview_urlstringread-only

bodystring

tagsarray[string]

summarystringread-only

is_publishedboolean

published_dateobject

published_date_iso8601string

meta_descriptionstring or null

meta_keywordsstring or null

idinteger
read-only

preview_urlstring
read-only

summarystring
read-only

titlestring
required

bodystring
required

preview_urlstring
read-only

summarystring
read-only

idinteger
read-only

preview_urlstring
read-only

summarystring
read-only

titlestring
required

bodystring
required

preview_urlstring
read-only

summarystring
read-only