Retail Express Python API Docs | dltHub

Retail Express is a RESTful API platform that provides access to Retail Express POS and retail management data such as products, customers, orders, outlets, inventory, and financial summaries for integrations. The REST API base URL is https://api.retailexpress.com.au and requests require an API Key to obtain a Bearer token, which must then be passed in the Authorization header along with the x-api-key header.

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 add "dlt[hub]" and start loading Retail Express data in under 10 minutes.

---

What data can I load from Retail Express?

Here are some of the endpoints you can load from Retail Express:

---

How do I authenticate with the Retail Express API?

Authentication requires a two-step process: first, exchange an API key (passed via the x-api-key header) for a short-lived Bearer access token, then include that token in the Authorization header along with the x-api-key header for all subsequent API requests. The access token expires after 60 minutes.

1. Get your credentials

1. Log in to your Retail Express account with an administrator user.\n2. Navigate to Settings > Integrations > API Management.\n3. Enter a descriptive name in the API Key Name field.\n4. Enter a description for the integration in the API Key Description field (if required).\n5. Select Enabled.\n6. Click Generate Keys.\n7. Copy either the Primary Key or the Secondary Key. Both keys are functionally identical. Store this key securely as it is sensitive. Note: You must have the 'API Management' security permission enabled in your staff profile to access this section. Contact Retail Express sales if you require a license to access the API.

2. Add them to .dlt/secrets.toml

Copy
[sources.retail_express_source]
api_key = "REPLACE_ME"

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 init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub 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
uv run dlthub ai toolkit install rest-api-pipeline

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 Retail Express 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
uv run python retail_express_pipeline.py

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

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

Inspect your pipeline and data:

Copy
uv run dlthub 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 /auth/token and /products from the Retail Express 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 retail_express_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.retailexpress.com.au",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "products", "endpoint": {"path": "v2.1/products", "data_selector": "products"}},
            {"name": "orders", "endpoint": {"path": "v2.1/orders", "data_selector": "orders"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="retail_express_pipeline",
        destination="duckdb",
        dataset_name="retail_express_data",
    )
    load_info = pipeline.run(retail_express_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("retail_express_pipeline").dataset()
sessions_df = data.products.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM retail_express_data.products LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("retail_express_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 Retail Express 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.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• 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