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. It is the same as the `optionId` used in the request.
value string The product option value. For example, Red or Medium
valueId number The product option value identifier. It is the same as the `optionValue` used in the request.
View JSON Schema on GitHub

JSON Schema

bigcommerce-responsecartlineitemsitemsphysicalitemsitemsallof0optionsite-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseCartLineItemsItemsPhysicalItemsItemsAllOf0OptionsItems",
  "title": "Product Option",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The product option name. For example, Color or Size"
    },
    "nameId": {
      "type": "number",
      "description": "The product option identifier. It is the same as the `optionId` used in the request.",
      "example": 125
    },
    "value": {
      "type": "string",
      "description": "The product option value. For example, Red or Medium"
    },
    "valueId": {
      "type": "number",
      "description": "The product option value identifier. It is the same as the `optionValue` used in the request.",
      "example": 127
    }
  },
  "x-internal": false
}