• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index
You are viewing an old version of the API
CatalogItemOption BETA

A group of variations for a CatalogItem.

Properties
Name Description
name
string

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.
display_name
string

The item option's display name for the customer. This is a searchable attribute for use in applicable query filters.
description
string

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.
show_colors
boolean

If true, display colors for entries in values when present.
values
CatalogObject [ ]

A list of CatalogObjects containing the CatalogItemOptionValues for this item.