BigCommerce · Schema

blogPost_Base_Post

blogPost base for POST requests

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
title string Title of this blog post.
url string URL for the public blog post.
body string Text body of the blog post.
tags array 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 t
meta_description string Description text for this blog post’s `` element.
meta_keywords string Keywords for this blog post’s `` element.
author string Name of the blog post’s author.
thumbnail_path string Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV).
published_date string
View JSON Schema on GitHub

JSON Schema

bigcommerce-blogpost-base-post-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/blogPost_Base_Post",
  "title": "blogPost_Base_Post",
  "type": "object",
  "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"
  },
  "description": "blogPost base for POST requests",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of this blog post.",
      "example": "Welcome to BigCommerce"
    },
    "url": {
      "type": "string",
      "description": "URL for the public blog post.",
      "example": "/blog/welcome-bigcommerce/"
    },
    "body": {
      "type": "string",
      "description": "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": {
      "type": "array",
      "description": "Tags to characterize the blog post.",
      "items": {
        "type": "string"
      }
    },
    "is_published": {
      "type": "boolean",
      "description": "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.",
      "default": false,
      "example": true
    },
    "meta_description": {
      "type": "string",
      "description": "Description text for this blog post\u2019s `<meta/>` element.",
      "example": "Welcome Post"
    },
    "meta_keywords": {
      "type": "string",
      "description": "Keywords for this blog post\u2019s `<meta/>` element.",
      "example": "BigCommerce, welcome, ecommerce"
    },
    "author": {
      "type": "string",
      "description": "Name of the blog post\u2019s author.",
      "example": "BigCommerce"
    },
    "thumbnail_path": {
      "type": "string",
      "description": "Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV)."
    },
    "published_date": {
      "type": "string",
      "example": "Wed, 10 Aug 2022 15:39:15 -0500"
    }
  },
  "required": [
    "title",
    "body"
  ]
}