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

Object Index

You are viewing an old version of the API
CatalogCustomAttributeDefinition BETA

Contains information defining a custom attribute.

Custom attributes are intended to store additional information about a catalog object or to associate a catalog object with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). Read more about custom attributes

Properties

Name Description
type
string

Required

The type of this custom attribute. Cannot be modified after creation. Required.

name
string

Required

The name of this definition for API and seller-facing UI purposes. The name must be unique within the (merchant, application_id) pair. Required. May not be empty and may not exceed 255 characters. Can be modified after creation.

Max Length 255 Min Length 1
description
string

Seller-oriented description of the meaning of this Custom Attribute, any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.

Max Length 255
source_application
SourceApplication

Read only. Contains information about the application that created this custom attribute definition.

allowed_object_types
string [ ]

Required

The set of Catalog Object Types that this Custom Attribute may be applied to. Currently, only ITEM and ITEM_VARIATION are allowed. At least one type must be included.

seller_visibility
string

The visibility of a custom attribute in seller-facing UIs (including Square Point of Sale applications and Square Dashboard). May be modified.

app_visibility
string

The visibility of a custom attribute to applications other than the application that created the attribute.

string_config
CatalogCustomAttributeDefinitionStringConfig

Optionally, populated when type = STRING, unset otherwise.

number_config
CatalogCustomAttributeDefinitionNumberConfig
selection_config
CatalogCustomAttributeDefinitionSelectionConfig

Populated when type is set to SELECTION, unset otherwise.

custom_attribute_usage_count
integer

Read-only. The number of custom attributes that reference this custom attribute definition. Set by the server in response to a ListCatalog request with include_counts set to true. If the actual count is greater than 100, custom_attribute_usage_count will be set to 100.

key
string

The name of the desired custom attribute key that can be used to access the custom attribute value on catalog objects. Cannot be modified after the custom attribute definition has been created. Must be between 1 and 60 characters, and may only contain the characters [a-zA-Z0-9_-].

Max Length 60 Min Length 1

Share Feedback

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