<- Object

Object

All versions ->

CatalogImage

An image file to use in Square catalogs.

It can be associated with catalog items, item variations, and categories.

Link to section

Properties

Link to section

name

string

The internal name to identify this image in calls to the Square API. This is a searchable attribute for use in applicable query filters using the SearchCatalogObjects. It is not unique and should not be shown in a buyer facing context.

Link to section

url

string

The URL of this image, generated by Square after an image is uploaded using the CreateCatalogImage endpoint.

Link to section

caption

string

A caption that describes what is shown in the image. Displayed in the Square Online Store. This is a searchable attribute for use in applicable query filters using the SearchCatalogObjects.