The Catalog API provides a way to retrieve product and price book data from a merchant. This data enables you to know which products can be included in a purchase request. Since the catalog is configurable by the merchant via the SumUp POS, we also provide a webhook so you can know when product or price book data is updated.
Business Use Cases
Get Price Books
The primary use case is retrieving a list of price books. The merchant will have a price book configured for each integration partner, and this enables you to get the price book associated with your integration.
Each price book contains a list of products, a list of packages, and a list of plannings. Each product contains a list of option choices with their related list of options. Each package contains a list of package components with their related list of product selections.
Price Books Webhook
Since the catalog is configurable by the merchant via the SumUp POS, here you will be able to find a webhook to be notified when price books are updated. You will be able to subscribe to price books and receive notifications about changes to them.
Each notification will contain enough information for you to understand which price books have changed, and you will decide what you want to do with this information.
Simplified Architecture Diagram
Glossary & Global Rules
For more information, please refer to our Glossary and Global Rules pages.