Skip to main content

​
Developer Guides

Welcome to the Kibo Commerce Developer Guides. These technical guides provide hands-on tutorials and code examples for working with Kibo’s APIs, helping you build robust integrations and custom solutions.

​
Catalog & Products

Catalog Admin API

Managing products, attributes, product types, and categories

Storefront Catalog API

Customer-facing product display, search, and navigation

Pricing API

Price lists, pricing strategies, and B2B/B2C pricing

Inventory API

Location-based inventory management and stock tracking

​
Commerce & Orders

Cart API

Managing shopping carts and checkout flows

Commerce/OMS API

Order imports for OMS integrations

Reservation API

Temporary inventory holds during checkout

Subscription API

Recurring orders and subscription management

​
Fulfillment & Locations

Shipments API

Fulfillment shipment management and dispatch

Shipment Packages API

Physical package creation and tracking

Order Routing API

Intelligent fulfillment routing and distribution

Location Admin API

Managing fulfillment locations and capabilities

Location Groups API

Grouping locations for inventory and routing

​
Platform & Administration

Customer API

Customer accounts, addresses, and authentication

Admin User API

User management, roles, and permissions

Settings API

Business configuration and site settings

Entities API

Custom data storage for extensions

​
Data & Events

Import/Export API

Bulk data operations and file management

Events/Webhooks API

Webhook subscriptions and event notifications

​
How to Use These Guides

Each developer guide follows a consistent structure designed to help you quickly understand and implement API integrations:
  1. Understanding the Domain - High-level overview of the API’s purpose and architecture
  2. How It Fits Into Kibo - Integration points with other platform domains
  3. Prerequisites - Required setup and knowledge
  4. Fundamentals - Core concepts and data structures
  5. Code Examples - Working code samples with explanations
  6. Common Mistakes - Pitfalls to avoid
  7. Troubleshooting - Error handling and debugging tips

​
Getting Started

If you’re new to Kibo API development, we recommend starting with these foundational guides:
  1. [Catalog Admin API](/developer-guides/catalog-admin-api - How to manage product data
  2. Cart API - Building shopping experiences
  3. Inventory API - Understanding location-based inventory
  4. Customer API - Managing customer accounts

​
Need Help?

These developer guides provide hands-on code examples for API integration. For conceptual overviews and business context, see the Concept Guides. For complete API specifications, visit the API Reference.