Stock Management

This page describes the process of configuring and managing stock levels.


For a product to be recognized, it must be marked as in stock in the product catalogue.

It is critical to integrate existing software that manages stock availability with the Recognition API. When a product comes into stock and when it goes out of stock (or is discontinued), the Recognition API should be automatically updated.

Managing Stock

Products go into and out of stock as seasons change and as stock runs out, or new stock is delivered. To get the best performance out of the Recognition API, they need to be set to the correct state within the API. If a product that is actually in stock, is not set to in stock in the Tiliter API, it will not be recognized.

It is critical to establish practices and processes that ensure that stock state is updated within the Tiliter Recognition API in close to realtime as stock levels change in store.

Generally this would involve connecting existing stock systems with the API in order to ensure the updates are automatic and timely.

It is not recommended to manage stock by hand.

Here's how to set a stock as available using a Unix-like command-line interface:

curl --request PUT --url --header 'accept: application/json' --header 'content-type: application/json' --header 'tiliter-api-key: YOUR_API_KEY' --data ' { "stock_states": [ { "stock_state": "available", "product_id": "product_id" } ] } '

The stock state can also be out_of_stock and discontinued.

More information on the product parameters can be found in Stores and Stock.

Stock can be Update Store Stock, and retrieved using the API functions provided.

Once stock is set, the initial configuration is done and the Recognition API can be used.


The Recognition API can only recognize products that are in the product catalogue, and mapped to a Tiliter Archetype, and in stock. Managing stock is required to use the Recognition API. Good management of stock state result in the best outcomes, performance, and accurate and useful usage and performance statistics. For more information, see Stores and Stock.