Load Magento 2 REST API data to DuckDB

Magento 2 REST API provides endpoints for managing commerce catalog, order, and customer workflows for Adobe Commerce and Magento Open Source stores. Everything needed to build a working Magento 2 REST API → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your Magento 2 REST API to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Magento 2 REST API to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Magento 2 REST API API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

Magento 2 REST API API at a glance

These values come from the Magento 2 REST API API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the Magento 2 REST API API?

Requests require an Authorization header using the Bearer authentication scheme, where the token is obtained by authenticating against specific admin or customer token endpoints.

1. Get your credentials

To obtain credentials for Magento 2 (Adobe Commerce) API integration: 1. Log in to your Magento Admin panel. 2. Navigate to System > Extensions > Integrations. 3. Click Add New Integration. 4. Fill in the required fields (Name, Email, etc.) and enter your current Admin password to authorize the change. 5. Click the API tab in the left sidebar and select the specific resources the integration needs to access (e.g., Catalog, Sales). 6. Save the integration. 7. Return to the Integrations grid, find your new integration, and click Activate. 8. Review the requested permissions and click Allow. 9. The system will then display your Consumer Key, Consumer Secret, Access Token, and Access Token Secret.

2. Add them to .dlt/secrets.toml

Copy
[sources.magento_2_rest_api_source]
consumer_key = "your_consumer_key"
consumer_secret = "your_consumer_secret"
access_token = "your_access_token"
access_token_secret = "your_access_token_secret"
base_url = "https://your-magento-site.com"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What Magento 2 REST API data can I load into DuckDB?

These are the Magento 2 REST API endpoints dlt can load into DuckDB:

---

How do I load only new Magento 2 REST API records?

Magento 2 REST API exposes updated_at on V1/orders, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

Copy
{"name": "orders", "endpoint": {
    "path": "V1/orders",
    "data_selector": "items",
    "incremental": {"cursor_path": "updated_at", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated Magento 2 REST API pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /rest/V1/integration/admin/token and /rest/V1/integration/customer/token from the Magento 2 REST API API into DuckDB:

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

@dlt.source
def magento_2_rest_api_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<magento_host>/rest/<store_code>/V1/",
            "auth": {"type": "bearer", "token": access_token},
        },
        "resources": [
            {"name": "orders", "endpoint": {"path": "V1/orders", "data_selector": "items"}},
            {"name": "products", "endpoint": {"path": "V1/products", "data_selector": "items"}}
        ],
    }
    yield from rest_api_resources(config)


def load_magento_2_rest_api_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="magento_2_rest_api_pipeline",
        destination="duckdb",
        dataset_name="magento_2_rest_api_data",
    )
    load_info = pipeline.run(magento_2_rest_api_source())
    print(load_info)


if __name__ == "__main__":
    load_magento_2_rest_api_to_duckdb()

Run it with python magento_2_rest_api_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query Magento 2 REST API data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("magento_2_rest_api_pipeline").dataset()
df = data.orders.df()
print(df.head())

SQL:

Copy
SELECT * FROM magento_2_rest_api_data.orders LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the Magento 2 REST API to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw Magento 2 REST API loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Magento 2 REST API data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack