Catalog API

How It Works

Catalog API process flow Permalink Get a link to this section

The following example process flow shows how a seller application might interact with the Catalog API:

  1. The application frontend collects catalog item information from the seller.

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

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

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

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

    process-flow