<- Catalog API

Catalog API

Create catalog image

POST

 /v2/catalog/images

The resulting CatalogImage is unattached to any CatalogObject if the object_id is not specified.

This CreateCatalogImage endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.

Permissions:ITEMS_WRITE

Guide

Upload and Attach an Image

Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request.

See Idempotency keys for more information.

Min Length
1
Link to section

object_id

string

Unique ID of the CatalogObject to attach this CatalogImage object to. Leave this field empty to create unattached images, for example if you are building an integration where an image can be attached to catalog items at a later time.

Link to section

image

Required

The new CatalogObject of the IMAGE type, namely, a CatalogImage object, to encapsulate the specified image file.

Link to section

is_primary

boolean

Beta

If this is set to true, the image created will be the primary, or first image of the object referenced by object_id. If the CatalogObject already has a primary CatalogImage, setting this field to true will replace the primary image. If this is set to false and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of image_ids on the object.

With Square API version 2021-12-15 or later, the default value is false. Otherwise, the effective default value is true.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

image

The newly created CatalogImage including a Square-generated URL for the encapsulated image file.

Error descriptions