BigCommerce · Schema

productCustomField_Put

The model for a PUT to update a custom field on a product.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
id integer The unique numeric ID of the custom field; increments sequentially. Required to update existing custom field in /PUT request. Read-Only
name string The name of the field, shown on the storefront, orders, etc. Required for /POST
value string The name of the field, shown on the storefront, orders, etc. Required for /POST
View JSON Schema on GitHub

JSON Schema

bigcommerce-productcustomfield-put-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/productCustomField_Put",
  "title": "productCustomField_Put",
  "required": [
    "name",
    "value"
  ],
  "type": "object",
  "properties": {
    "id": {
      "minimum": 1,
      "type": "integer",
      "description": "The unique numeric ID of the custom field; increments sequentially. Required to update existing custom field in /PUT request.\nRead-Only",
      "example": 6
    },
    "name": {
      "maxLength": 250,
      "minLength": 1,
      "type": "string",
      "description": "The name of the field, shown on the storefront, orders, etc. Required for /POST\n",
      "example": "ISBN",
      "x-required": [
        "post"
      ]
    },
    "value": {
      "maxLength": 250,
      "minLength": 1,
      "type": "string",
      "description": "The name of the field, shown on the storefront, orders, etc. Required for /POST\n",
      "example": "1234567890123",
      "x-required": [
        "post"
      ]
    }
  },
  "description": "The model for a PUT to update a custom field on a product.",
  "x-internal": false
}