API Guides

Articles

Making API Calls
In order to make API calls, you need to be familiar with the hostname options to identify your tenant, site, and environment as well as any context headers you may need to include. API Host You can make calls to either a production...
API Best Practices
Kibo recommends some best practices when interfacing with the Kibo Composable Commerce Platform (KCCP) APIs to improve system efficiency and minimize potential problems such as server load and slow performance. Your tenant should be set up to fol...
Sorting and Filtering APIs
Instead of making a GET call to retrieve a single object based on a known identifier, filters or combinations of filters can be used to create a search query instead. As a collection of results will be returned, sorting can also be applied to the ...
Status Codes
When working with the Kibo Composable Commerce Platform (KCCP), client developers may encounter a number of response codes. These include generic HTTP statuses that apply to all API calls, as well as error codes that are unique to KCCP or occur on...
Response Fields
The responses returned by a GET operation can be large: they may include payloads such as Order objects or Product objects that contain over a hundred properties each. Depending on the specific data you want to retrieve, you may not always need th...
Payment Gateway Responses
The Kibo Composable Commerce Platform (KCCP) uses payment gateways to process credit card transactions. To process credit card transactions on your storefront, you must set up a payment gateway and then assign that gateway to payment types. You...
Live Editing Products
You can make immediate edits to products that are live on your storefront even if your product publishing setting is set to staged and you currently have pending draft changes for that product using the live editing feature of the Kibo Composable ...
Transactional Logs
The Kibo Composable Commerce Platform makes Transactional Logs (TLogs) available to clients as an accounting tool intended for reconciliation purposes. Five TLogs are sent: Sales, Transfers, Credits, Cancels, and Returns. These reports inclu...
Getting Started with Postman
Postman is an API development application that facilitates the building and testing of API requests, which are important parts of implementation. This guide explains those tasks for anyone unfamiliar with Postman or request structures in general. ...
Batch Import via APIs
Some APIs support "batch import" which is a slightly different method for submitting and processing update requests. This allows you to send a large batch of updates before marking them as ready for processing, at which point Kibo will b...
Google Feed
Kibo's Google Feed enables you to export data from the catalog structure using API and update product details on Google search results. For example, when a user searches product details for a specific website, the website displays various fie...