Kibo OMS Application

Configuration Guide

Current Version: 1.0.0 (May 2017)
Install: Kibo eCommerce App Marketplace
More Info: Version History

Kibo Order Management System (OMS) is a distributed order management system that connects inventory across your ecosystem to your customers in real-time, thereby enabling flexible, convenient, and cost-efficient delivery. The Kibo OMS Application integrates the functionality of OMS into your Kibo eCommerce solution. Typical OMS use cases include:

Application Features:

Install the App

You can install the Kibo OMS Application directly from the Kibo eCommerce App Marketplace:

  1. Go to: www.kibocommerce.com/marketplace
  2. In the Search field, enter: Kibo OMS
  3. Click the app icon.
  4. On the app page, click Install Now.

After the application installs to your tenant, log in to Dev Center and install it on the sandbox(es) of your choice:

  1. Log in to Dev Center.
  2. Click Develop > Application.
  3. Double-click Kibo OMS Application.
  4. Click Install and select the sandbox of your choice from the list.

You can now configure the Kibo OMS Application through Admin on any sandbox in which it is installed.

Configure the Application

To integrate your Kibo OMS services with Kibo eCommerce, review the configuration requirements to ensure you have everything you need to be successful before you begin, and then complete the steps in this section.

Configuration Requirements

Obtain Kibo OMS Account Credentials

Contact your Kibo OMS professional services team to obtain your Kibo OMS credentials, which you need to configure the Kibo OMS Application. The credentials you need to obtain are:

Configure the App

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo OMS Application.
  3. Click the Configuration link to open configuration settings.
  4. Open the Settings tab.
    1. Enter the Account Settings you obtained from your Kibo OMS professional services team.
    2. Enter your Inventory Import Settings you obtained from your Kibo OMS professional services team. Configure your SFTP server, choose whether to display real-time inventory data on your storefront's product pages and/or checkout pages, and choose whether to append your tenant ID to your external order ID within Kibo OMS so you can more easily identify incoming data.
    3. Click Save.
  5. Open the Locations tab.

    You can sync your locations using one of two methods:

    1. You can sync locations by uploading a comma-separated spreadsheet or text file.Tip:  The format for a comma-separated spreadsheet should look like:

      First ColumnSecond ColumnThird Column
      eCommerce Location CodeOMS Location IDOMS Location Name


      The format for a text file should look like:

      eCommerce Location Code,OMS Location ID,OMS Location Name
    2. Alternatively, you can also sync your locations manually by using the Kibo OMS Location drop-down menu to assign an OMS location to its corresponding eCommerce location.
  6. Note: If you have location syncing settings set in both Kibo OMS and the OMS application configuration page in Kibo eCommerce, the location sync settings on both pages must match.
  7. Open the Order Attributes tab.
    1. Use the search bar to select which custom order attributes to export from Kibo eCommerce to Kibo OMS.

    2. Click Save.
  8. Open the Product Attributes tab.
    1. Use the drop-down menu to select the catalog containing the product attributes you want to export from Kibo eCommerce to Kibo OMS.
    2. Click Select Master Catalog.
    3. Use the search bar to select which product attributes to export from Kibo eCommerce to Kibo OMS.
    4. Click Save.
  9. Open the Catalog tab.
    1. Use the Kibo OMS Catalog drop-down menu to assign an OMS catalog to its corresponding eCommerce site.
    2. Click Save.
  10. Open the Inventory Import tab.
    1. Click Select File to browse for a comma-separated spreadsheet or text file on your local system import.
    2. Indicate whether this file is an aggregate inventory file or a location inventory file.
    3. Select Upload File.

Subscribe to OMS Events

You can subscribe to OMS events to receive updates for orders sent to your OMS application. To subscribe to OMS events:

  1. Contact your OMS representative for access to the OMS event subscription page.
  2. Login using your OMS credentials.
  3. Add subscriptions for each manufacturer you want to receive updates. The subscription uses the endpoint (link to application)/OMS/shipmentStatus, the method is web service, and the content type is JSON.

Enable the App

After configuration, enable the Kibo OMS Application. To enable the app:

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo OMS Applications.
  3. Click Enable App.

Use the App

Check Inventory Import Results

The Kibo OMS Application works by automatically importing inventory data from Kibo OMS to Kibo eCommerce. You can check the results of the imports in the Configuration.

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo OMS Application.
  3. Click the Configuration link to open configuration settings.
  4. Open the Inventory Import Results tab.
  5. View the inventory log.

Retry Failed Orders

You can resend orders that failed to process correctly by accessing the OMS Orders screen in Admin.

  1. In Admin, go to Main > Fulfillment > Orders.
  2. Select the Om icon at the top of the screen, and then click OMS > Orders.
  3. Click the Retry button for the order you want to resend.

Export Product Attributes to Kibo OMS

When you pass an order to Kibo OMS for fulfillment, you can select which product attributes you want to send to the Kibo OMS system.

To select product attributes to export:

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo OMS Application.
  3. Click the Configuration link to open configuration settings.
  4. Open the Product Attributes tab.
  5. In the drop-down box, select the catalog containing the attributes you want to send to Kibo OMS.
  6. In the next box underneath, select the product attributes you want to send to Kibo OMS.
  7. Select Save.