BigCommerce · Schema

Product Custom Field Data

Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product’s page, such as a book’s ISBN or a DVD’s release date.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	integer	The unique numeric ID of the custom field increments sequentially. Read-Only.
name	string	The name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.
value	string	The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customFieldData",
  "title": "Product Custom Field Data",
  "type": "object",
  "properties": {
    "id": {
      "minimum": 1,
      "type": "integer",
      "description": "The unique numeric ID of the custom field increments sequentially. Read-Only.",
      "example": 6
    },
    "name": {
      "maxLength": 250,
      "minLength": 1,
      "type": "string",
      "description": "The name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.\n",
      "example": "ISBN"
    },
    "value": {
      "maxLength": 250,
      "minLength": 1,
      "type": "string",
      "description": "The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.\n",
      "example": "1234567890123"
    }
  },
  "description": "Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product\u2019s page, such as a book\u2019s ISBN or a DVD\u2019s release date."
}