MedusaJS Python API Docs | dltHub

Build a MedusaJS-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

MedusaJS Admin API Reference provides authenticated request methods and customizable API routes. Use JWT, API tokens, or session IDs for authentication. Customize admin dashboard with Medusa UI package. The REST API base URL is {MEDUSA_BASE_URL}/admin and Admin APIs require a secret API token, JWT Bearer token, or session cookie for authentication..

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


What data can I load from MedusaJS?

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

ResourceEndpointMethodData selectorDescription
products/admin/productsGETproductsList products (supports pagination)
product/admin/products/:idGETproductRetrieve a single product
orders/admin/ordersGETordersList orders
order/admin/orders/:idGETorderRetrieve a single order
customers/admin/customersGETcustomersList customers
return_reasons/admin/return-reasonsGETreturn_reasonsList return reason objects
collections/admin/collectionsGETcollectionsList collections
regions/admin/regionsGETregionsList regions
product_variants/admin/variantsGETvariantsList product variants
discounts/admin/discountsGETdiscountsList discounts (if enabled)

How do I authenticate with the MedusaJS API?

Medusa Admin APIs accept a secret API token via the x-medusa-access-token header, a JWT via Authorization: Bearer <token>, or an authenticated session cookie.

1. Get your credentials

  1. Log into your Medusa Admin UI. 2) Navigate to Settings → Secret API Keys. 3) Click the Create button and give the key a title. 4) Copy the displayed token and store it securely; it cannot be viewed again.

2. Add them to .dlt/secrets.toml

[sources.medusajs_source] api_token = "your_medusa_secret_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:

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 MedusaJS 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 medusajs_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline medusajs_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 MedusaJS 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 medusajs_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "{MEDUSA_BASE_URL}/admin", "auth": { "type": "api_key", "api_token": api_token, }, }, "resources": [ {"name": "products", "endpoint": {"path": "admin/products", "data_selector": "products"}}, {"name": "orders", "endpoint": {"path": "admin/orders", "data_selector": "orders"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="medusajs_pipeline", destination="duckdb", dataset_name="medusajs_data", ) load_info = pipeline.run(medusajs_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("medusajs_pipeline").dataset() sessions_df = data.products.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM medusajs_data.products LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("medusajs_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 MedusaJS data to?

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

DestinationExample 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 MedusaJS?

Request dlt skills, commands, AGENT.md files, and AI-native context.