Build a Simple Catalog

Applies to: Catalog API

Learn how to build a simple product catalog for a cafe that serves coffee in small and large sizes, with skim or whole milk.

Link to section

Overview

To build this catalog, you call the UpsertCatalogObject endpoint to create the following catalog objects to represent the for-sale item (Coffee). You include two variations (Small Coffee and Large Coffee) of the sale item, a CatalogTax object as taxes applied to the coffee item, and two optional modifications (with Skim Milk and Whole Milk).

The following steps are generally applicable to creating catalog objects of other types, except for uploading an image object. For information about how to upload an image to a catalog and attach it to an item, item variation, or category, see Work with Images.

Link to section

Requirements and limitations

  • You have a Square account enabled for payment processing. If you haven't enabled payment processing on your account (or you're not sure), visit squareup.com/activation.
  • You are familiar with HTTPS. If this is your first time working with HTTPS, see TLS and HTTPS before continuing.
Link to section

1. Add a coffee item to a catalog

Important

When creating an item, you must also specify at least one variation. Otherwise, you get an INVALID_REQUEST error.

To add a coffee item to a catalog as a product offering of a seller, call the UpsertCatalogObject endpoint to create a CatalogItem object in the catalog. This is shown in the following REST API example:

Upsert catalog object

In this example, the Coffee item has two variations (Small and Large).

The #coffee ID is a temporary ID, serving as a placeholder for the permanent ID that the Square API generates and returned in the response. In the same request payload where the temporary ID is defined, you can use the temporary ID value to reference this to-be-created object. The two variations in this example use #coffee to identify its parent item. If these variations were created in a separate request, you must use their Square-generated permanent ID values to reference them.

Because the UpsertCatalogObject endpoint is used to create other catalog objects, the data object you specify must match the specified type property value. In this example, you must set the item_data property to an appropriate CatalogItem object to match the ITEM type and set the item_variation_data property to an appropriate CatalogItemVariation object to match the ITEM_VARIATION type. Similarly, to set up a discount to be applied to an order, you must specify an appropriate CatalogDiscount object on the discount_data field while setting the type value to DISCOUNT. In summary, the type property must match the {object_type}_data property.

When the request is successful, you get a 200 OK response with a payload similar to the following:

Note that the response returns the ID mapping between the temporary ID (id_mappings.client_object_id) value and the Square-generated ID (object_id) value. From now on, you must reference these objects by their respective object_id values.

In this example, the coffee item's product_type is unspecified in the request. This is equivalent to setting product_type to REGULAR.

Link to section

Create the coffee item as a food and beverage item explicitly

You can set product_type to FOOD_AND_BEV to create the coffee or another food and beverage item explicitly. This is useful if you want to include the food and beverage details (such as the calorie count, ingredients, or dietary preferences) in the resulting item.

For example, the following request recreates the coffee item with an explicit product_type of FOOD_AND_BEV to contain information about the calorie count and dietary preference:

Upsert catalog object

The additional food and beverage details are returned in the successful response:

If you create the coffee or another food or beverage as a REGULAR item and include the food and beverage details in the request, the specified the food and beverage details are ignored and not returned in the response.

Link to section

2. Create a CatalogTax object for the coffee drink

In most locales, a sales tax must be levied on a sold product. To support taking taxes on an order, you must first create a CatalogTax object to set up the tax to be applied when the payment is made on the order.

The following code example shows how to create a tax object and add it to the catalog:

Upsert catalog object

In this example, the drink tax is 7.5% of the pre-tax subtotal of an order.

When successful, the request returns a 200 OK response with the payload similar to the following:

Alternatively, you can combine the calls to create the Coffee item with the Small and Large variations and the Drink Tax object into a single call to the BatchUpsertCatalogObjects endpoint, as shown:

Batch upsert catalog objects

Link to section

3. Create a modifier list to contain two modifiers

To enable sellers to offer the choices of adding skim milk and whole milk to the coffee drink, you can create two catalog modifiers to apply to the Coffee item. One way to add the modifiers is to create a modifier list containing individual modifiers as its entries.

The following example shows how to call the UpsertCatalogObject endpoint to create the CatalogModifierList object with two CatalogModifier objects for Skim Milk and Whole Milk:

Upsert catalog object

The successful operation returns a 200 OK response with a payload similar to the following:

For the modifiers in the modifier list be applied to the Coffee item, you must have the resultant modifier list applied to the Coffee item, as explained in step 4.

Link to section

4. Apply the modifier list to the coffee item

To apply the modifier list created in step 3, call the UpdateItemModifierLists endpoint as shown in the following example:

Update item modifier lists

If successful, the operation returns a 200 OK response with a payload similar to the following:

{ "updated_at": "2020-06-15T18:36:39.58Z" }

Alternatively, you can call the BatchUpsertCatalogObjects endpoint to create a modifier list with appropriate modifier entries and add the modifier list to the Coffee item, together with the required item variations, in a single call to create all related CatalogObject instances at once.

Link to section

5. Verify the catalog you just built

After building your catalog, you can view and verify it by calling the ListCatalog endpoint to inspect the catalog items. The following request shows an example:

List catalog

In response, the payload contains the catalog objects:

Link to section

See also