Inventory Import


This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

Kibo clients typically have extensive inventory data to share. While Kibo best practices recommend using the Inventory REST APIs, which provide better error handling and faster responses, the Bulk Data Exchange tools are also available. The Inventory Import process provides current stock-level information to Kibo. This real-time inventory data helps OMS accurately assign orders to fulfillment locations and set product availabilities. Some clients who have multiple fulfillment locations use inventory data to manage inventory levels and assign orders to those multiple locations.

For clients upgrading from a previous version of OMS to the Unified Commerce Platform, the process to import an inventory file remains unchanged. This includes the data fields within the files, as the platform’s translation layer is applied to these files to enable backwards compatibility.

Types of Inventory Import

Two types of Inventory Import processes exist: Refreshes and Updates. Refreshes are more comprehensive and usually sent once per day, providing the total count for all products in the catalog. Updates are normally sent every hour and provide an adjustment to the values sent in the previous Refresh, indicating which product counts should be increased or decreased.

Refresh File Attributes

  • Delivered to Kibo once each day
  • Represents an accurate stock count for all products
  • Includes products with a stock count of zero (0)

Update File Attributes

  • Delivered to Kibo throughout the day
  • Increments (+2) or decrements (-2) existing stock count(s)
  • Sometimes called a ‘trickle’ feed

Getting Started

The client must have identified the SFTP (Secure File Transfer Protocol) site where Kibo picks up the inventory files. There needs to be a provide a username, password, remote path, and remote path archive for the file transmission location.

Creating and Uploading the Files

Inventory data should be submitted as XML or CSV files and compressed into Zip format before being transferred.

A Trigger/Control file should also be created each time data is submitted. The Trigger file tells Kibo that the inventory file is ready to process. This is an empty file with the same file name as the inventory files being submitted, and the extension .done (ex.

The zipped file should be uploaded to the SFTP site followed by the Trigger file.

Naming Inventory Import Files

Inventory files should be named with the following conventions, depending on what type of inventory import it is:



  • _REFRESH_ identifies this file as a Refresh, and should be entered literally.
  • _UPDATE_ identifies this file as an Update, and should be entered literally.
  • YYMMDD is the year, month, and day represented in two-digit format. For example, 130301 is March 1, 2013
  • hhmmss is the time in Pacific Standard Military Time, expressed as hour-minute-second, that the file was created. For example, 205912 is 10:59:12 p.m. PT.

Substitute KIBO with the designated client/company name. This convention makes it easier for Kibo to track the file through its job queues.

Data Elements

These parameters are used in both CSV and XML file formats. When building the file, identify a location name and then follow it with blocks of the item-specific data for each product.

Location NameYesStringThe identifier of the location that is submitting inventory data. Note that this value should actually be the external ID for the location, not the name as stored in the OMS admin. This is due to the inventory system looking for a “Location Name” variable, but requiring it to match the external ID.
Part NumberYesStringThe merchant-assigned Part Number for the item.
UPCOptionalStringThe UPC for the item.
SKUOptionalStringThe SKU for the item.
QuantityYesIntegerIf this is a Refresh, this is the number of the item in inventory. Examples are 352 and 4. If this is an Update, this value includes a + (plus) or – (minus), and is the change in quantity from the previous submission. Examples are +352 and -4.
BinOptionalIntegerThe name of the bin within a location. Used for warehouse and store management. It must exist for the LocationName.
LTDOptionalIntegerCustom field used for store prioritization. Kibo will advise you on the type of data to enter in this field if you need to use it.
Safety StockOptionalIntegerQuantity of this item you want to keep in stock to ensure your stock isn’t completely depleted. Both Safety Stock and Floor are optional; most people prefer Safety Stock to Floor.
FloorOptionalIntegerAbsolute minimum quantity of this item that should be in stock at any time. Both Safety Stock and Floor are optional; the two values are used for similar purposes; most people prefer to use Safety Stock rather than Floor.
CurrencyIDOptionalIntegerField defining which currency is used to store the RetailPrice. Required if RetailPrice is passed in. See the Currency API for details
RetailPriceOptionalDecimalThe location specific price the product being refreshed. CurrencyID is required if RetailPrice is passed in.
AttributesOptionalArrayA list of attributes that are assigned to the item.
InventoryLocatorNameOptionalStringAn identifier to indicate where a particular SKU exists within a location. For example, “Aisle 5” would indicate that the bin this item belongs to is located in Aisle 5. The maximum length is 50.


Here is an example import sequence:

  1. Create the file : KIBO_REFRESH_130909121152.xml (or .csv)
  2. Compress (zip) the file :
  3. Upload the zip file.
  4. Upload a Trigger/Control file :

XML File

The following example provides inventory information for two locations and includes only required elements.

<?xml version="1.0" encoding="UTF-8"?>
         <InventoryLocatorName>Aisle 2</InventoryLocatorName>
         <SafetyStock />
         <Floor />
         <LTD />
         <InventoryLocatorName>Aisle 3</InventoryLocatorName>
         <InventoryLocatorName>Aisle 4</InventoryLocatorName>
         <InventoryLocatorName>Aisle 5</InventoryLocatorName>

CSV File 

The following example provides inventory information for two locations. Note that CSV has some special requirements:

  • The header is optional
  • Order of inventory fields matters: LocationName,PartNumber,UPC,SKU,Quantity,Bin,etc.
  • String fields must be quoted
"0001","PartNumber1","UPC1","SKU1",11,"BinName1",1.0,2,4,1,25.99,,"Aisle 1"
"0001","PartNumber2","","SKU1",44,"BinName2",,"Aisle 2"
"0002","PartNumber1","UPC1","SKU1",11,,1.0,2,1,,"Aisle 3"
"0002","PartNumber2","","SKU2",44,,"Aisle 4"

Additional Resources