Configuration Endpoints

This page provides an overview of the configuration endpoints available in the Recognition API. The purpose is introduce each of these in one page, and provide links and references to learn more.

Information about how to make a valid request to these endpoints can be found in the API Reference.

Store Management

The Store Management family of endpoints are used to create, view, edit, and delete stores. These endpoints must be called in order to set up any store to use the Tiliter Recognition API.

These endpoints can be used to develop tooling for a retailer, or retailer management provider, in order to manage stores.

For more context, and for information on when and why to use these endpoints, see Store Management.

For more information on how to use these endpoints, see the Stores and Stock section in the API Reference.

NameEndpointMethodAPI ReferenceDescription
Create Storehttps://recognition.services.tiliter.com/stores/{store_id}POSThttps://developer.tiliter.com/reference/create_storeCreate new stores with this endpoint. Required to set up initially, and whenever a new store is onboarded to use the Recognition API.
Get Storehttps://recognition.services.tiliter.com/stores/{store_id}GEThttps://developer.tiliter.com/reference/get_storeRetrieve information about a single store based on its store ID.
List Storeshttps://recognition.services.tiliter.com/stores/GEThttps://developer.tiliter.com/reference/list_storesRetrieve information about all stores.
Update Storehttps://recognition.services.tiliter.com/stores/{store_id}PUThttps://developer.tiliter.com/reference/update_storeUpdates information about a single store
Delete Storehttps://recognition.services.tiliter.com/stores/{store_id}DELETEhttps://developer.tiliter.com/reference/delete_storeDeletes a single store.

Device Management

The Device Management family of endpoints are used to create, view, edit, and delete devices. These endpoints must be called in order to set up devices to use the Tiliter Recognition API.

These endpoints can be used to develop tooling for a retailer, or retailer management provider, in order to manage devices.

For more context, and for information on when and why to use these endpoints, see Device Management

For more information on how to use these endpoints, see the Devices section in the API Reference.

NameEndpointMethodAPI ReferenceDescription
Create Devicehttps://recognition.services.tiliter.com/devices/{device_id}POSThttps://developer.tiliter.com/reference/create_deviceCreate new devices. Required to set up initially, and whenever a new device is onboarded to use the Recognition API.
Get Devicehttps://recognition.services.tiliter.com/devices/{device_id}GEThttps://developer.tiliter.com/reference/get_deviceRetrieve information about a single device based on its device ID.
List Deviceshttps://recognition.services.tiliter.com/devices/GEThttps://developer.tiliter.com/reference/list_devicesRetrieve information about all devices.
Update Devicehttps://recognition.services.tiliter.com/devices/{device_id}PUThttps://developer.tiliter.com/reference/update_deviceUpdates information about a single device
Delete Devicehttps://recognition.services.tiliter.com/devices/{device_id}DELETEhttps://developer.tiliter.com/reference/delete_deviceDeletes a single device.

Product Management

The Product Management family of endpoints are used to create, view, edit, and delete products. These endpoints must be called in order to create an accurate product catalogue, which is required to use the Tiliter Recognition API.

These endpoints can be used to develop tooling for a retailer, or retailer management provider, in order to manage products.

For more context, and for information on when and why to use these endpoints, see Product Management

For more information on how to use these endpoints, see the Products section in the API Reference.

NameEndpointMethodAPI ReferenceDescription
Create Producthttps://recognition.services.tiliter.com/products/{product_id}POSThttps://developer.tiliter.com/reference/create_productCreate new products. Required to set up initially, and whenever a new product is onboarded to use the Recognition API.
Get Producthttps://recognition.services.tiliter.com/products/{product_id}GEThttps://developer.tiliter.com/reference/get_productRetrieve information about a single product based on its product ID.
List Productshttps://recognition.services.tiliter.com/products/GEThttps://developer.tiliter.com/reference/list_productsRetrieve information about all products.
Update Producthttps://recognition.services.tiliter.com/products/{product_id}PUThttps://developer.tiliter.com/reference/update_productUpdates information about a single product
Delete Producthttps://recognition.services.tiliter.com/products/{product_id}DELETEhttps://developer.tiliter.com/reference/delete_productDeletes a single product.
Get Product Issueshttps://recognition.services.tiliter.com/product_catalogue/issuesGEThttps://developer.tiliter.com/reference/get_product_issuesRetrieves all current product issues. Product issues will impact system performance.

Product Mapping

The Product Mapping family of endpoints are used to map products to Tiliter Archetypes. This process is required in order to get useful responses from the /recognition/ endpoint.. These endpoints can be used to develop tooling for a retailer, or retailer management provider, in order to map products to Tiliter Archetypes.

These endpoints must be called to create a connection between the Tiliter Archetypes, and the products in the store.

For more context, and for information on when and why to use these endpoints, see Product Mapping.

For more information on how to use these endpoints, see the Product Mapping and Archetypes section in the API Reference.

NameEndpointMethodAPI ReferenceDescription
List Archetypeshttps://recognition.services.tiliter.com/archetypes/GEThttps://developer.tiliter.com/reference/list_archetypesRetrieves the list of all Tiliter Archetypes. This information is required in order to map products accurately.
Create Product Mappinghttps://recognition.services.tiliter.com/product_mappings/POSThttps://developer.tiliter.com/reference/create_product_mappingCreate a map between a product and a Tiliter Archetype.
Get Product Mappinghttps://recognition.services.tiliter.com/product_mappings/{product_id}GEThttps://developer.tiliter.com/reference/get_product_mappingRetrieve a mapping for a single product, given its product ID. Each product can only have one mapping.
List Product Mappingshttps://recognition.services.tiliter.com/product_mappings/GEThttps://developer.tiliter.com/reference/list_product_mappingsRetrieve all product mappings.
Update Product Mappinghttps://recognition.services.tiliter.com/product_mappings/PUThttps://developer.tiliter.com/reference/update_product_mappingUpdate a product mapping. This allows you to change a product's mapping from one Tiliter Archetype to another.
Delete Product Mappinghttps://recognition.services.tiliter.com/product_mappings/{product_id}DELETEhttps://developer.tiliter.com/reference/delete_product_mappingDeletes a product mapping. The product will no longer be recognised.

Stock Management

These endpoints are used to set stock availability. All products are in stock by default after they are created, and these endpoints must be called to set them as out of stock, or back in stock, as stock levels and seasons change.

These endpoints can be used to develop tooling for a retailer, or retailer management provider, in order to manage products.

For more context, and for information on when and why to use these endpoints, see Stock Management

For more information on how to use these endpoints, see the Stores and Stock section in the API Reference.

NameEndpointMethodAPI ReferenceDescription
Update Store Stockhttps://recognition.services.tiliter.com/stores/{store_id}/stockPUThttps://developer.tiliter.com/reference/update_store_stockUpdate the stock availability of a product. If a product is out of stock or discontinued, it will no longer be recognised.
Get Store Stockhttps://recognition.services.tiliter.com/stores/{store_id}/stockGEThttps://developer.tiliter.com/reference/get_store_stockRetrieves the stock availability of all products in a store. Only products listed as available will be recognised.

What’s Next

After reviewing the Configuration Endpoints, take a deep dive into the Store Management section