BigCommerce · Schema

Custom Field Post

Payload for POST request to create custom fields associated with a product.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
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/customFieldPost",
  "title": "Custom Field Post",
  "required": [
    "name",
    "value"
  ],
  "type": "object",
  "properties": {
    "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": "Payload for POST request to create custom fields associated with a product."
}