You are viewing an old version of the API
Upload item image
V1

Deprecated

Note We recommend using the Square API (V2) for all new development when possible.

Uploads a JPEG or PNG image and sets it as the master image for an item



If you upload an image for an item that already has a master image, the new image replaces the existing one.

The request body assumes the multipart boundary for the request is set to BOUNDARY in the Content-Type header, for example:

Content-Type: multipart/form-data; boundary=BOUNDARY

Note: some HTTP libraries will set the multipart boundary for you.

Required permissions ITEMS_WRITE

Path Parameters

Name Description
location_id
string

Required

The Square-issued location ID indicating where the item is available.

item_id
string

Required

The Square-issued ID of the item to modify.

Request Body

Name Description
image_data
byte

Required

The binary image data.

Response Fields

Name Description
id
string

The image's unique ID.

url
string

The image's publicly accessible URL.

Examples

You are viewing an old version of the API
POST /v1/{location_id}/items/{item_id}/image

Share Feedback

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