BigCommerce · Schema

Custom Field Put

Payload for PUT request to update custom fields associated with a product.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
name string The value 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

bigcommerce-customfieldput-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customFieldPut",
  "title": "Custom Field Put",
  "type": "object",
  "properties": {
    "name": {
      "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": "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 PUT request to update custom fields associated with a product."
}