• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
Docs Sign In
Docs
Square API
API Reference API Explorer Square SDKs
Web
Setup guide SDK reference
Mobile
Setup guide iOS reference Android reference
Setup guide iOS reference Android reference
Setup guide iOS reference Android reference
Developer forums Slack community Contact support
Developer dashboard Settings
Seller dashboard Sign out

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

An instance of a custom attribute.

Custom attributes can be defined and added to ITEM and ITEM_VARIATION type catalog objects. Read more about custom attributes.

Properties
Name Description
name
string

The name of the custom attribute.
string_value
string

The string value of the custom attribute. Populated if type = STRING.
custom_attribute_definition_id
string

Read only Read-only. The id of the CatalogCustomAttributeDefinition this value belongs to.
type
string

Read only Read-only. A copy of type from the associated CatalogCustomAttributeDefinition.
number_value
string

Populated if type = NUMBER. Contains a string representation of a decimal number, using a . as the decimal separator.
boolean_value
boolean

A true or false value. Populated if type = BOOLEAN.
selection_uid_values
string [ ]

One or more choices from allowed_selections. Populated if type = SELECTION.
key
string

Read only Read-only. A copy of key from the associated CatalogCustomAttributeDefinition.

Share feedback

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