API Overviews

Articles

Dynamic Categories API Overview
The dynamic category expression controls the product membership of the dynamic category. Dynamic Category Types There are two types of dynamic categories: precomputed and realtime. Precomputed Categories The product membership of precomputed c...
Fulfillment API Overview
You can use the Fulfillment APIs to process shipments through their fulfillment processes by placing a series of calls identifying the action you want to perform on the shipment. This guide provides a reference for shipment data such as the suppo...
Inventory API Overview
There are several important concepts to understand before interfacing with the Inventory APIs - best practices for handling large amounts of data, how inventory levels are calculated, how inventory jobs are defined, and how segmentation tags are c...
Real-Time Inventory Service APIs
The Real-Time Inventory Service APIs provide accurate and real-time inventory visibility to your eCommerce site. These APIs give information such as Get Group Site Availability,  Get Product Site Availability, Get Product Availability at Loca...
Multiple Addresses API Overview
This topic outlines how to use APIs to manage shipping to multiple destinations. Note that this process does not serve the same function as a standard order with one fulfillment address (single ship). Instead, it allows order items to be fulfilled...
Orders API Overview
This topic provides an overview of the orders and order drafts REST API components. Refer to Orders  in the Guides section for more information about orders, including order attributes, order statuses, and managing orders in the Admin ...
Order Routing API Overview
Although the Order Routing UI is the easiest way to configure routing resources, some configurations and testing can be performed via API. The Order Routing APIs are grouped into four topics for supporting data lists, filters, groups, and routing....
Price Lists API Overview
This topic provides an overview of the price list REST API components. Price lists allow you to override the catalog pricing of products for specific customer segments and/or sites. You can override a product's list price, sale price, and oth...
Purchase Order API Overview
This topic provide an overview of the purchase order REST API components. Unified Commerce's purchase order functionality allows your shoppers to use a purchase order as a payment method on your storefront. Refer to Purchase Orders in the ...
Returns API Overview
This topic outlines how to use the API to create and process returns. Create a Return To create a return, use the CreateReturn operation. When creating a return, make sure to include all required fields as detailed in the API reference topic. A...
Search Settings API Overview
Storefront search capabilities within the Kibo Composable Commerce Platform (KCCP) are supported by Solr 8 and an extensive set of configurable options that can be customized for the implementation. This guide explains several of the concepts abou...
Shipping Carriers API Overview
You can manage carriers and carrier credentials via the Shipping Admin APIs . The Shipping Admin APIs have replaced the former Carrier Service API (also known as CARS), so all management of credentials via API should be done through the endpoints...