A group of variations for a CatalogItem
.
CatalogItemOption
Name | Type | Tags | Description |
---|---|---|---|
name |
string | undefined |
Optional | The item option's display name for the seller. Must be unique across all item options. This is a searchable attribute for use in applicable query filters. |
displayName |
string | undefined |
Optional | The item option's display name for the customer. This is a searchable attribute for use in applicable query filters. |
description |
string | undefined |
Optional | The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. This is a searchable attribute for use in applicable query filters. |
showColors |
boolean | undefined |
Optional | If true, display colors for entries in values when present. |
values |
CatalogObject[] | undefined |
Optional | A list of CatalogObjects containing theCatalogItemOptionValue s for this item. |
{
"name": null,
"display_name": null,
"description": null,
"show_colors": null,
"values": null
}