Kibo Composable Commerce Python API Docs | dltHub
Build a Kibo Composable Commerce-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Kibo Composable Commerce API best practices improve system efficiency; key resources include API overview and application development best practices. Essential for integration and custom application development. The REST API base URL is https://{tenant_id}.{env_domain}/api and OAuth 2.0 (client_credentials) — requests require a Bearer access token.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Kibo Composable Commerce data in under 10 minutes.
What data can I load from Kibo Composable Commerce?
Here are some of the endpoints you can load from Kibo Composable Commerce:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| products | /commerce/catalog/products | GET | items | List/Search products (supports paging: page, pageSize) |
| categories | /commerce/catalog/categories | GET | items | List categories for a catalog/site |
| orders | /commerce/orders | GET | items | List orders (supports filters and paging) |
| customers | /commerce/customers | GET | items | List customers |
| carts | /commerce/carts | GET | items | List carts / active checkouts |
| product_types | /commerce/catalog/admin/attributedefinition/producttypes | GET | items | Get product type attribute definitions |
How do I authenticate with the Kibo Composable Commerce API?
Obtain an OAuth2 access token via client_id and client_secret using the platform token endpoint; include the token in Authorization: Bearer {access_token}. Additional context headers (x-vol-site, x-vol-catalog, x-vol-master-catalog, x-vol-locale, x-vol-version, x-vol-currency) may be required to scope API calls.
1. Get your credentials
- Open the Kibo Dev Center and create/register an Application. 2) Note the Application (Client) ID and Shared Secret in the Application core details. 3) Use those values to request a token from the tenant auth endpoint (POST https://{tenant_host}/api/platform/applications/authtickets/oauth with client_id, client_secret, grant_type=client_credentials). 4) Store client_id and client_secret in secrets and use them to obtain access_token which you include as Authorization: Bearer {access_token}.
2. Add them to .dlt/secrets.toml
[sources.kibo_composable_commerce_source] client_id = "your_client_id_here" client_secret = "your_shared_secret_here" tenant_id = "t12345" auth_host = "https://t12345.sandbox.mozu.com"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Kibo Composable Commerce API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python kibo_composable_commerce_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline kibo_composable_commerce_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset kibo_composable_commerce_data The duckdb destination used duckdb:/kibo_composable_commerce.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline kibo_composable_commerce_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads products and orders from the Kibo Composable Commerce API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def kibo_composable_commerce_source(client_credentials=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{tenant_id}.{env_domain}/api", "auth": { "type": "oauth2_client_credentials", "access_token": client_credentials, }, }, "resources": [ {"name": "products", "endpoint": {"path": "commerce/catalog/products", "data_selector": "items"}}, {"name": "orders", "endpoint": {"path": "commerce/orders", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="kibo_composable_commerce_pipeline", destination="duckdb", dataset_name="kibo_composable_commerce_data", ) load_info = pipeline.run(kibo_composable_commerce_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("kibo_composable_commerce_pipeline").dataset() sessions_df = data.products.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM kibo_composable_commerce_data.products LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("kibo_composable_commerce_pipeline").dataset() data.products.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Kibo Composable Commerce data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Kibo Composable Commerce?
Request dlt skills, commands, AGENT.md files, and AI-native context.