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

Object Index
You are viewing an old version of the API
CatalogImage

An image file to use in Square catalogs.

It can be associated with CatalogItem, CatalogItemVariation, CatalogCategory, and CatalogModifierList objects. Only the images on items and item variations are exposed in Dashboard. Only the first image on an item is displayed in Square Point of Sale (SPOS). Images on items and variations are displayed through Square Online Store. Images on other object types are for use by 3rd party application developers.

Properties
Name Description
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.
url
string

The URL of this image, generated by Square after an image is uploaded using the CreateCatalogImage endpoint. To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.
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.
photo_studio_order_id
string
Beta

The immutable order ID for this image object created by the Photo Studio service in Square Online Store.