Blog Posts
Get All Blog Posts
GET https://api.bigcommerce.com/stores/{store_hash}/v2/blog/postsRequest
Returns all Blog Posts. Default sorting is by published_date, beginning with the most recent post.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- 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
example
Create a Blog Post
POST https://api.bigcommerce.com/stores/{store_hash}/v2/blog/postsRequest
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 apublished_date
in RFC 2822 format. - Blog posts default to draft status. To publish blog posts to the storefront, set the
is_published
property totrue
. - 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 headerrequired
Parameters
- store_hash in path - string
Body
blogPost base for POST requests
titlestring
requiredTitle of this blog post.
Example: Welcome to BigCommerceurlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/bodystring
requiredText body of the blog post.
Example: <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>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: trueDefault: false
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
blog post base response
titlestring
Title of this blog post.
Example: Welcome to BigCommerceurlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/preview_urlstring
read-onlyURL to preview the blog post. READ-ONLY.
Example: /blog/welcome-bigcommerce/bodystring
Text body of the blog post.
Example: <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>summarystring
read-onlySummary of the blog post. READ-ONLY.
Example: <p>We power ecommerce websites for successful retailers all over the world</p>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: trueDefault: false
published_dateobject
published_date_iso8601string
Published date in
ISO 8601
format.Example: 5/18/2023 1:26:42 PMthumbnail_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/postsRequest
Deletes a page of Blog Posts
.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- 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 headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the blog post.
example
Response
Body
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 <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example request includes apublished_date
in RFC 2822 format. -
Blog posts default to draft status. To publish blog posts to the storefront, set the
is_published
property totrue
.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the blog post.
Body
blogPost base for POST requests
titlestring
requiredTitle of this blog post.
Example: Welcome to BigCommerceurlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/bodystring
requiredText body of the blog post.
Example: <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>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: trueDefault: false
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
blog post base response
titlestring
Title of this blog post.
Example: Welcome to BigCommerceurlstring
URL for the public blog post.
Example: /blog/welcome-bigcommerce/preview_urlstring
read-onlyURL to preview the blog post. READ-ONLY.
Example: /blog/welcome-bigcommerce/bodystring
Text body of the blog post.
Example: <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>summarystring
read-onlySummary of the blog post. READ-ONLY.
Example: <p>We power ecommerce websites for successful retailers all over the world</p>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: trueDefault: false
published_dateobject
published_date_iso8601string
Published date in
ISO 8601
format.Example: 5/18/2023 1:26:42 PMthumbnail_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 headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
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/countRequest
Returns a count of all Blog Posts.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
countnumber
Example: 27