BigCommerce · Schema

Product Option

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
name string The product option name; for example, Color or Size.
nameId number The product option identifier.
value string The product option value; for example, Red or Medium.
valueId number The product option value identifier in number format.
View JSON Schema on GitHub

JSON Schema

bigcommerce-productoption-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProductOption",
  "title": "Product Option",
  "type": "object",
  "x-internal": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "The product option name; for example, Color or Size."
    },
    "nameId": {
      "type": "number",
      "description": "The product option identifier."
    },
    "value": {
      "type": "string",
      "description": "The product option value; for example, Red or Medium."
    },
    "valueId": {
      "type": "number",
      "description": "The product option value identifier in number format.",
      "example": 128
    }
  }
}