• 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 catalog items, item variations, and categories.

Properties

Name Description
name
string

The internal name to identify this image in calls to the Square API.

url
string

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

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.

Share Feedback

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