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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- is_published in query - booleanFilter param.
- url in query - stringFilter param. Value must be URL encoded.
- tag in query - stringFilter param.
- published_date in query - stringFilter param.
- page in query - integerFilter param.
- limit in query - integerFilter param.
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/blog/posts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Body
array | application/json
idinteger
read-onlyID of this blog post. READ-ONLY.Example: 3titlestring
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 inISO 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
[
{
"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>",
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 RFC 2822. 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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
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
{
"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": [
"string"
],
"summary": "<p>We power ecommerce websites for successful retailers all over the world</p>",
"is_published": true,
"published_date": "Thu, 18 May 2023 13:26:42 -0000",
"published_date_iso8601": "5/18/2023 1:26:42 PM",
"meta_description": "Welcome Post",
"meta_keywords": "BigCommerce, welcome, ecommerce",
"author": "BigCommerce",
"thumbnail_path": "string"
}
Response
Body
object | application/json
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 inISO 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
{
"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",
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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- page in query - integerFilter param.
- limit in query - integerFilter param.
example
curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/blog/posts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
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 - stringrequiredThe MIME type of the response body.
- id in path - integerrequiredID of the blog post.
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/blog/posts/[id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Body
object | application/json
blog post base response
idinteger
read-onlyID of this blog post. READ-ONLY.Example: 3titlestring
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 inISO 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
{
"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",
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 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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- id in path - integerrequiredID of the blog post.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
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
{
"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": [
"string"
],
"summary": "<p>We power ecommerce websites for successful retailers all over the world</p>",
"is_published": true,
"published_date": "Thu, 18 May 2023 13:26:42 -0000",
"published_date_iso8601": "5/18/2023 1:26:42 PM",
"meta_description": "Welcome Post",
"meta_keywords": "BigCommerce, welcome, ecommerce",
"author": "BigCommerce",
"thumbnail_path": "string"
}
Response
Body
object | application/json
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 inISO 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
{
"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",
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 - stringrequiredThe MIME type of the response body.
- id in path - integerrequiredID of the blog post.
example
curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/blog/posts/[id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
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 header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/blog/posts/count' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Body
object | application/json
countnumber
Example: 27
example
{
"count": 27
}
Did you find what you were looking for?