X-Cart Python API Docs | dltHub

X-Cart is a PHP-based e-commerce platform exposing store data via a REST API (REST API add-on for 5.05.4 and built-in API Platform endpoints in 5.5+). The REST API base URL is For API Platform (X-Cart 5.5+): https://<your-store-domain>/api; For legacy REST add-on (<=5.4): admin.php?target=RESTAPI endpoint on your store host (e.g. https://<your-store-domain>/admin.php?target=RESTAPI with REST path passed via _path or direct REST client calling admin.php path). and Admin REST add-on: X-Auth-Token header (API key); API Platform (5.5+): JWT Bearer token (Authorization: Bearer ) for storefront/admin endpoints as documented..

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 X-Cart data in under 10 minutes.

---

What data can I load from X-Cart?

Here are some of the endpoints you can load from X-Cart:

---

How do I authenticate with the X-Cart API?

All REST requests require an auth header: legacy add-on requires X-Auth-Token with the API key; X-Cart 5.5 storefront API requires obtaining a JWT at /api/storefront/auth/login then include Authorization: Bearer . Include Accept: application/json and optional Accept-Language header for localization.

1. Get your credentials

1. Log in to X-Cart Admin.
2. Go to Settings > API (REST add-on) and create an API key (read or read/write) for legacy add-on.
3. For API Platform (5.5+), use storefront auth endpoints: POST /api/storefront/auth/login with credentials to obtain JWT (follow developer docs for payload and scopes).
4. Store the returned key (X-Auth-Token) or JWT securely.

2. Add them to .dlt/secrets.toml

Copy
[sources.x_cart_source]
For legacy add-on: api_key = "your_rest_api_key"
For API Platform (JWT): jwt = "your_jwt_token"

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:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
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:

Copy
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 X-Cart 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:

Copy
python x_cart_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline x_cart_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset x_cart_data
The duckdb destination used duckdb:/x_cart.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline x_cart_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 X-Cart API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def x_cart_source(For legacy: api_key; For API Platform (token): token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "For API Platform (X-Cart 5.5+): https://<your-store-domain>/api; For legacy REST add-on (<=5.4): admin.php?target=RESTAPI endpoint on your store host (e.g. https://<your-store-domain>/admin.php?target=RESTAPI with REST path passed via _path or direct REST client calling admin.php path).",
            "auth": {
                "type": "legacy: api_key; API Platform: bearer",
                "legacy: api_key; API Platform: token": For legacy: api_key; For API Platform (token): token,
            },
        },
        "resources": [
            {"name": "products", "endpoint": {"path": "api/products"}},
            {"name": "orders", "endpoint": {"path": "api/orders"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="x_cart_pipeline",
        destination="duckdb",
        dataset_name="x_cart_data",
    )
    load_info = pipeline.run(x_cart_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):

Copy
import dlt

data = dlt.pipeline("x_cart_pipeline").dataset()
sessions_df = data.products.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM x_cart_data.products LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("x_cart_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 X-Cart data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

Ensure X-Auth-Token header (legacy) or Authorization: Bearer (5.5+) is present and valid; 401 is returned for missing/invalid token. Create API key in Settings > API or obtain JWT via /api/storefront/auth/login.

Pagination and limits

Collections are paginated by default (30 items per page). Use itemsPerPage and page query params; maximum itemsPerPage is 100. Legacy _cnd[limit] offset/limit parameters also supported.

Output formats and headers

Use Accept: application/json (default) and Accept-Language for localization. API may return 304 if If-Modified-Since/If-None-Match headers match.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack