Inventory API overview

Note: A new version V3 of the Inventory API is released, replacing the previous versions. Previous versions are now deprecated but will remain available until 31 May, 2023.

To migrate to V3, see Inventory API migration guide.

The Inventory service keeps track of stock levels for product variants. The Inventory API is used for example when building integrations between POS systems and e-commerce systems.

Zettle system overview with Inventory service.

Getting started

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.

Explore the sections in the following to get an overview of the different parts of the Inventory API.

Understanding inventories

API clients can list current stock levels and update inventory balances for products. The service automatically decreases the stock when a purchase is made with the Zettle POS application. Tracking is based on moving product items between Locations. See How inventories work for concept descriptions.

Working with inventories

Manage inventory tracking

To be able to work with inventory balances, tracking must be enabled for the products you want to manage inventory balances for. Inventory tracking is enabled on a product basis and can be enabled/disabled at any time.

Manage locations

When an organisation starts using the inventory, the inventory service will generate a set of default locations. Location endpoints are used for retrieving these locations. The location UUIDs are then used with other inventory management functionality to manage stock levels.

Manage inventory balances

This area contains endpoints used for managing tracked products, and for retrieving and updating stock information. Here you can fetch and update inventory balances for specific products and locations.

Manage low stock levels

This functionality is used for defining low stock levels and updating the low stock alert settings. This is done to ensure merchants have the right inventory balance to meet current demand without having an excess in stock. Through these endpoints you can retrieve and update the low stock configurations.