BigCommerce · Schema

Property

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	integer	An internal identifier used by other operations.
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	Optional. 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.
created_at	string	Datetime.
updated_at	string	Datetime.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Property",
  "title": "Property",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "An internal identifier used by other operations.",
      "example": 1,
      "readOnly": true
    },
    "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": "Optional. 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"
    },
    "created_at": {
      "type": "string",
      "description": "Datetime.",
      "format": "date-time",
      "example": "2022-07-21 19:33:57+00:00",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "description": "Datetime.",
      "format": "date-time",
      "example": "2022-07-21 19:33:57+00:00",
      "readOnly": true
    }
  }
}