Catalog

Catalog system is what you can buy.

Any masking, user permissions, or other restrictions based on the user context (client, staff, owner, etc.) will be taken into account when the results are ready. For example, if a staff user is requesting a list of items but they do not have the permission to view gift cards, any gift card items will be removed from the results.

Searching the catalog

Getting a tip item

• To apply tips to a cart, you need to add the tip item to the cart. In order to get the correct tip item and appropriate information, use the Search/Tip endpoint. To learn more about the Search/Tip endpoint, please see the dynamic API documentation here.

CatalogItem

The CatalogItem represents a singular item that is available for purchase.

It is intended to include all details necessary to implement a UI simply based on the details of the item.

See the CatalogItem object specification for more details.

CatalogPacakge

The CatalogPackage represents a collection of CatalogItems

It is intended to include all details necessary to implement a UI simply based on the details of the item.