BigCommerce · Schema

PropertyPOST

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
code string The unique string programmatically references this unique tax property by the tax provider. Merchants should liaise with their tax provider to explore supported values and functions.
display_name string The human-readable name for this property. This string will be displayed on the Products screen as a field label.
description string Additional detail about this tax property may help guide merchants. This string will be displayed on the Products screen as a tooltip associated with the relevant field.
View JSON Schema on GitHub

JSON Schema

bigcommerce-propertypost-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PropertyPOST",
  "title": "PropertyPOST",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "The unique string programmatically references this unique tax property by the tax provider. Merchants should liaise with their tax provider to explore supported values and functions.",
      "example": "A-123456789"
    },
    "display_name": {
      "type": "string",
      "description": "The human-readable name for this property. This string will be displayed on the Products screen as a field label.",
      "example": "Example Tax Property 1"
    },
    "description": {
      "type": "string",
      "description": "Additional detail about this tax property may help guide merchants. This string will be displayed on the Products screen as a tooltip associated with the relevant field.",
      "example": "Food Industry"
    }
  },
  "required": [
    "code",
    "display_name"
  ]
}