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

Object Index

You are viewing an old version of the API
CatalogItemOptionValue BETA

An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values.

Properties

Name Description
item_option_id
string

Unique ID of the associated item option.

name
string

Name of this item option value. This is a searchable attribute for use in applicable query filters.

description
string

A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.

color
string

The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). Only displayed if show_colors is enabled on the parent ItemOption. When left unset, color defaults to white ("#ffffff") when show_colors is enabled on the parent ItemOption.

ordinal
integer

Determines where this option value appears in a list of option values.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?