These guides provide examples for many tasks that a developer will need to be familiar with during implementation.



Inventory: Overview

While Bulk Data Exchange tools allow the user to upload inventory files, Kibo’s Inventory REST APIs provide a more efficient and responsive process. There are four primary API actions to manage product inventory. This includes two types of inquiries, which return information about quantity levels of products sorted either by location or by aggregate, a refresh API to specify what the quantity of an item should be, and an adjustment API that updates quantity based on incremental change rather than total amount.

The maximum number of items per API call is 12,000. However, OMS processes these items in batches of 3,000, so intervals of 3,000 are most efficient. The API performs parsing and validation on these batches that allows it to quickly respond with error codes, which can be logged before the user fixes the errors and re-tries the request. In contrast, the Bulk Data Exchange file upload does not immediately report data error when dropping the file.

The following guides explain each of these processes:

Each includes information about the call, a sample request and response, and quick links to the relevant schemas and Postman collections. Choose a guide from the links above or the navigation menu to find out more.