Catalog API

How It Works

A deeper look at Catalog API.

Catalog API

The Catalog API process flow
Permalink Get a link to this section

Here is an example process flow for how a merchant application might interact with the Catalog API.

  1. Application frontend collects catalog item information from merchant user.

  2. The application backend packages a CatalogObject request object and sends it to the UpsertCatalogObject endpoint.

  3. Square adds the catalog objects to the merchant's user products and returns the catalog object to the application backend.

  4. The application backend captures the result and displays a success message to the merchant.

  5. The merchant can now retrieve information about this catalog item or reference it in calls to the Orders API.

process-flow