Square

Square Catalog API

The Catalog API from Square — 13 operation(s) for catalog.

Documentation GitHub OpenAPI

Business capability

Operations 14

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/catalog/batch-delete Delete several catalog objects at once · Square Batch Delete Catalog Objects #

Ask an LLM

“How do I delete a bunch of catalog items in one request?”

“Does deleting items in bulk also remove their variations?”

Tell an agent destructive · confirm first

Delete catalog objects {object_ids}.

Bulk-remove these items from my catalog: {object_ids}.

POST /v2/catalog/batch-retrieve Fetch several catalog objects by ID · Square Batch Retrieve Catalog Objects #

Ask an LLM

“Can I fetch many catalog items by their IDs in one call?”

“Is it possible to include related objects like taxes when fetching items by ID?”

Tell an agent

Get catalog objects {object_ids}.

Retrieve items {object_ids} with related objects included: {include_related_objects}.

POST /v2/catalog/batch-upsert Create or update catalog objects in bulk · Square Batch Upsert Catalog Objects #

Ask an LLM

“How do I import thousands of products into my Square catalog at once?”

“What happens if one object in a batch upsert fails?”

Tell an agent

Upsert these catalog batches: {batches}.

Bulk create or update catalog objects from {batches} with key {idempotency_key}.

POST /v2/catalog/images Upload a catalog image · Square Create Catalog Image #

Ask an LLM

“How do I add a product photo to an item in my catalog?”

“Can I upload an image and attach it to an existing catalog object?”

Tell an agent

Upload {image_file} as a new catalog image.

Create a catalog image from {image_file} using {request}.

PUT /v2/catalog/images/{image_id} Replace an existing catalog image file · Square Update Catalog Image #

Ask an LLM

“Can I swap out the photo on an existing catalog image?”

“How do I replace the file behind a catalog image without creating a new one?”

Tell an agent

Replace the file of catalog image {image_id} with {image_file}.

Update catalog image {image_id} with a new upload.

GET /v2/catalog/info Get catalog API batch size limits · Square Catalog Info #

Ask an LLM

“What are the batch size limits for catalog upserts?”

“Where do I find the Catalog API's limits and settings?”

Tell an agent

Show me the Catalog API limits.

Check the maximum batch sizes for catalog requests.

GET /v2/catalog/list List catalog objects by type · Square List Catalog #

Ask an LLM

“How do I list all items and categories in my catalog?”

“Can I list only certain object types, like taxes or discounts?”

Tell an agent

List all catalog objects of types {types}.

Page through my full catalog.

POST /v2/catalog/object Create or update one catalog object · Square Upsert Catalog Object #

Ask an LLM

“How do I add a single new item to my Square catalog?”

“Can I update one existing catalog object without a batch?”

Tell an agent

Create or update catalog object {object}.

Save this single item to my catalog: {object}.

DELETE /v2/catalog/object/{object_id} Delete one catalog object · Square Delete Catalog Object #

Ask an LLM

“How do I remove a single item from my catalog?”

“Will deleting one catalog item also delete its child variations?”

Tell an agent destructive · confirm first

Delete catalog object {object_id}.

Remove item {object_id} from my catalog.

GET /v2/catalog/object/{object_id} Get one catalog object · Square Retrieve Catalog Object #

Ask an LLM

“How can I view one catalog item with all its variations?”

“Can I see a catalog object as it was at a past catalog version?”

Tell an agent

Get catalog object {object_id}.

Show item {object_id} as of catalog version {catalog_version}.

POST /v2/catalog/search Search catalog objects of any type · Square Search Catalog Objects #

Ask an LLM

“Can I search catalog objects of any type by attribute values?”

“Is there a way to find catalog objects changed since a certain time?”

Tell an agent

Search catalog objects of types {object_types} matching {query}.

Find catalog objects updated since {begin_time}.

POST /v2/catalog/search-catalog-items Search items by text, category or stock · Square Search Catalog Items #

Ask an LLM

“How do I search my products by name or category?”

“Can I find items that are low on stock or enabled at a location?”

Tell an agent

Search catalog items for {text_filter}.

Find items in categories {category_ids} with stock levels {stock_levels}.

POST /v2/catalog/update-item-modifier-lists Enable or disable modifier lists on items · Square Update Item Modifier Lists #

Ask an LLM

“How do I attach a modifier list, like toppings, to several items?”

“Can I turn off a modifier list on items without re-saving the whole item?”

Tell an agent

Enable modifier lists {modifier_lists_to_enable} on items {item_ids}.

Disable modifier lists {modifier_lists_to_disable} for items {item_ids}.

POST /v2/catalog/update-item-taxes Apply or remove taxes on items · Square Update Item Taxes #

Ask an LLM

“How do I apply a sales tax to a group of catalog items?”

“Can I remove a tax from items without upserting the entire item?”

Tell an agent

Apply taxes {taxes_to_enable} to items {item_ids}.

Stop charging taxes {taxes_to_disable} on items {item_ids}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/square:square-catalog-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Catalog API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (293 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-catalog-api-openapi.yml

Square Catalog API

Operations 14

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification