Docs
Content API
Blog Posts

Blog Posts

Get All Blog Posts

GET /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
    required

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
  • id
    integer
    read-only

    ID of this blog post. READ-ONLY.

    Example: 3

  • title
    string

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • preview_url
    string
    read-only

    URL to preview the blog post. READ-ONLY.

    Example: /blog/welcome-bigcommerce/

  • body
    string

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • summary
    string
    read-only

    Summary of the blog post. READ-ONLY.

    Example: <p>We power ecommerce websites for successful retailers all over the world</p>

  • is_published
    boolean

    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_date
    object

  • published_date_iso8601
    string

    Published date in ISO 8601 format.

    Example: 5/18/2023 1:26:42 PM

  • meta_description
    string or null

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string or null

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string or null

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string or null

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Create a Blog Post

POST /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 <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.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • 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

  • title
    string
    required

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • body
    string
    required

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • is_published
    boolean

    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_description
    string

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

  • published_date
    string

    Example: Wed, 10 Aug 2022 15:39:15 -0500

example

Response

Body

object | application/json

blog post base response

  • title
    string

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • preview_url
    string
    read-only

    URL to preview the blog post. READ-ONLY.

    Example: /blog/welcome-bigcommerce/

  • body
    string

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • summary
    string
    read-only

    Summary of the blog post. READ-ONLY.

    Example: <p>We power ecommerce websites for successful retailers all over the world</p>

  • is_published
    boolean

    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_date
    object

  • published_date_iso8601
    string

    Published date in ISO 8601 format.

    Example: 5/18/2023 1:26:42 PM

  • meta_description
    string or null

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string or null

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string or null

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string or null

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Delete Blog Posts

DELETE /blog/posts

Request

Deletes a page of Blog Posts.

Authentication

  • X-Auth-Token in header
    required

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 /blog/posts/{id}

Request

Returns a single Blog Post.

Authentication

  • X-Auth-Token in header
    required

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

application/json
  • id
    integer
    read-only

    ID of this blog post. READ-ONLY.

    Example: 3

  • title
    string

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • preview_url
    string
    read-only

    URL to preview the blog post. READ-ONLY.

    Example: /blog/welcome-bigcommerce/

  • body
    string

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • summary
    string
    read-only

    Summary of the blog post. READ-ONLY.

    Example: <p>We power ecommerce websites for successful retailers all over the world</p>

  • is_published
    boolean

    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_date
    object

  • published_date_iso8601
    string

    Published date in ISO 8601 format.

    Example: 5/18/2023 1:26:42 PM

  • meta_description
    string or null

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string or null

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string or null

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string or null

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

  • id
    integer
    read-only

    ID of this blog post. READ-ONLY.

    Example: 3

  • title
    string

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • preview_url
    string
    read-only

    URL to preview the blog post. READ-ONLY.

    Example: /blog/welcome-bigcommerce/

  • body
    string

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • summary
    string
    read-only

    Summary of the blog post. READ-ONLY.

    Example: <p>We power ecommerce websites for successful retailers all over the world</p>

  • is_published
    boolean

    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_date
    object

  • published_date_iso8601
    string

    Published date in ISO 8601 format.

    Example: 5/18/2023 1:26:42 PM

  • meta_description
    string or null

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string or null

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string or null

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string or null

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Update a Blog Post

PUT /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 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
    required

Parameters

  • store_hash in path - string
  • 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

  • title
    string
    required

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • body
    string
    required

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • is_published
    boolean

    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_description
    string

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

  • published_date
    string

    Example: Wed, 10 Aug 2022 15:39:15 -0500

example

Response

Body

object | application/json

blog post base response

  • title
    string

    Title of this blog post.

    Example: Welcome to BigCommerce

  • url
    string

    URL for the public blog post.

    Example: /blog/welcome-bigcommerce/

  • preview_url
    string
    read-only

    URL to preview the blog post. READ-ONLY.

    Example: /blog/welcome-bigcommerce/

  • body
    string

    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>

  • tags
    array[string]

    Tags to characterize the blog post.

  • summary
    string
    read-only

    Summary of the blog post. READ-ONLY.

    Example: <p>We power ecommerce websites for successful retailers all over the world</p>

  • is_published
    boolean

    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_date
    object

  • published_date_iso8601
    string

    Published date in ISO 8601 format.

    Example: 5/18/2023 1:26:42 PM

  • meta_description
    string or null

    Description text for this blog post’s <meta/> element.

    Example: Welcome Post

  • meta_keywords
    string or null

    Keywords for this blog post’s <meta/> element.

    Example: BigCommerce, welcome, ecommerce

  • author
    string or null

    Name of the blog post’s author.

    Example: BigCommerce

  • thumbnail_path
    string or null

    Local path to a thumbnail uploaded to /product_images/ using WebDAV.

example

Delete a Blog Post

DELETE /blog/posts/{id}

Request

Deletes a Blog Post.

Authentication

  • X-Auth-Token in header
    required

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 /blog/posts/count

Request

Returns a count of all Blog Posts.

Authentication

  • X-Auth-Token in header
    required

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
  • count
    number

    Example: 27

example

Did you find what you were looking for?