Veeqo Python API Docs | dltHub

Veeqo is a cloud‑based inventory and order management platform that provides a REST API for accessing ecommerce data. The REST API base URL is https://api.veeqo.com and Authentication is required via OAuth2 bearer token or API key (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 pip install "dlt[workspace]" and start loading Veeqo data in under 10 minutes.

---

What data can I load from Veeqo?

Here are some of the endpoints you can load from Veeqo:

---

How do I authenticate with the Veeqo API?

All requests must include either the x-api-key header with your API key or an Authorization: Bearer <token> header for OAuth2.

1. Get your credentials

1. Log into your Veeqo account.
2. Navigate to Settings → Users.
3. Click + NEW USER.
4. In the Actions column, click the pencil (edit) icon for the user.
5. Scroll to the API Key section and click Refresh API Key.
6. Copy the generated key; you may need to request enablement from support first.

2. Add them to .dlt/secrets.toml

Copy
[sources.veeqo_source]
api_key = "YOUR_API_KEY_HERE"

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 Veeqo 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 veeqo_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline veeqo_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 orders and products from the Veeqo 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 veeqo_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.veeqo.com",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "orders", "endpoint": {"path": "orders"}},
            {"name": "products", "endpoint": {"path": "products"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM veeqo_data.orders LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("veeqo_pipeline").dataset()
data.orders.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 Veeqo 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 Errors

If the x-api-key header is missing or the token is invalid, the API returns a 401 Unauthorized response.

Rate Limiting

Veeqo enforces a limit of 5 requests per second with a bucket size of up to 100 requests. Exceeding this limit results in a 429 Too Many Requests response. Clients should implement exponential backoff.

Pagination

Responses are paginated using page and per_page query parameters. If omitted, the API returns the first page with a default size.

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