Unified Commerce Order Management

This section of documentation is intended for clients being implemented on the Unified Commerce Platform. The API user guides in the lefthand menu provide basic parameter tables for each call (or a template indicating parameter names and data types) and sample requests or responses.

See this Postman collection for API request templates and examples of some API calls. This collection is currently a work in progress and may be missing some requests, so redownload it later to check for updates. Ask the Kibo team for more examples and Postman samples if desired.

Alternatively, see the schema index for a list of all calls supported by many of the APIs – including those without corresponding walkthroughs. These schemas define the supported request parameters and successful responses, and point to other useful documentation if applicable.

Although most of the documentation published here is focused on the new Order Management capabilities of the platform, some sections such as the Storefront Search APIs are applicable to eCommerce users as well. However, much of the documentation written for the previous version of eCommerce is still applicable and can be referenced for more extensive catalog and storefront-related API needs if it does not have new updates listed here. That linked website and the documentation here will be merged together in a new, comprehensive knowledge base coming up in 2021.

Order Management Overview

Understanding the basic organization of order management structures will help give context as to how these APIs are used. Fulfillment locations that have their own inventory records to indicate what products they can fulfill. When a customer places an order, it goes through Kibo’s routing system and is assigned to a location or multiple locations for fulfillment. However, orders are further broken down into “shipments” that are created by Unified Commerce Order Management when the order is assigned.

Shipments are objects that belong to an order, representing the different packages that the order is split into for fulfillment. Each shipment has its own record with a fulfillment status, tracking information, and item level aggregates (subtotals, tax, shipping charges, etc.) that are managed independently from the other shipments that may belong to the order. This enables a more accurate view of the physical fulfillment process in cases where the ordered products are being shipped separately.

The two fulfillment types currently supported in Unified Commerce are Ship to Home and Buy Online Pick Up In Store (sometimes also referred to as In Store Pick Up or a variant of that term).