Zettle APIs overview
The Zettle APIs provide options for integrating point of sale (POS) services.
For example, you have a service that runs a POS system, and you want to manage inventories in your e-commerce platform for merchants that use Zettle POS.
The following describes the APIs available for integrating with Zettle.
Authentication and authorisation is implemented with the OAuth 2.0 standard. The OAuth scope shows what access that your app users will authorise the app to their Zettle account data. For example, READ:PURCHASE means read-only access to purchase data.
| API | Use | OAuth scope | Commonly used with |
|---|---|---|---|
| Finance | Provides information about transactions that are processed through Zettle. The information includes account balance, all the transactions processed through Zettle, and payout. | READ:FINANCE |
|
| Gift Card | Provides information about purchases made through Zettle with a gift card | READ:PURCHASE |
|
| Image | Allows uploading of product images to be stored and used within the Zettle applications. | READ:PRODUCT |
|
| Inventory | Keeps track of the stock level for variants within products | READ:PRODUCTWRITE:PRODUCT | OAuth |
| OAuth2 | Handles authentication and authorisation for an integration with Zettle. It implements the OAuth 2.0 protocol. | Not applicable | All APIs |
| Product Library | Manages information about products in a merchant´s store. | READ:PRODUCT WRITE:PRODUCT |
|
| Purchase | Provides read-only information about purchases made through Zettle. | READ:PURCHASE |
|
| Pusher | Publishes information to the integrator's service. This information is data related to products, purchases, inventory, and so on. | Corresponding to events | All APIs |
Regardless of where you are located when building the app, you can only integrate with Zettle in supported markets.
Note: The Zettle APIs are currently not supported in the United States.
| Market | APIs |
|---|---|
| United States | Not supported |
| United Kingdom | Supported |
| Sweden | Supported |
| Brazil | Supported |
| Norway | Supported |
| Denmark | Supported |
| Finland | Supported |
| Germany | Supported |
| Mexico | Supported |
| Netherlands | Supported |
| France | Supported |
| Spain | Supported |
| Italy | Supported |
Register on the Zettle Developer Portal to create credentials for the app you are building, and learn more about different types of integrations. See Get started for more information.