No logo available for Order-desk to DuckDB connector icon

Load Order-desk data to DuckDB

Build a Order-desk to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Order-desk API base URL, auth, endpoints, and incremental loading.

SourceOrder-deskintroduction – Order Desk API ReferenceDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Order Desk is a RESTful platform providing programmatic access to an ecommerce store's orders, shipments, inventory items, and store settings. Everything needed to build a working Order-desk → 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 Order-desk to DuckDB pipeline

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

Prompt
Run uvx dlthub-init@latest to build a pipeline from Order-desk 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 Order-desk 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.


Order-desk API at a glance

Base URLhttps://app.orderdesk.me/api/v2
Example endpointGET orders
Records found atorders
Authenticationall requests require two header credentials, ORDERDESK-STORE-ID and ORDERDESK-API-KEY
Also requiredORDERDESK-STORE-ID, ORDERDESK-API-KEY
PaginationOffset-based page size via limit (default 50, max 500)
Incremental fieldoffset
Record idid
API referencehttps://apidocs.orderdesk.com/

These values come from the Order-desk API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the Order-desk API?

The API requires two specific custom headers for all requests: ORDERDESK-STORE-ID and ORDERDESK-API-KEY. These credentials must be obtained from the Store Settings API tab within the Order Desk application.

1. Get your credentials

To obtain your API credentials for the Order Desk REST API, follow these steps: 1. Log in to your Order Desk account. 2. Navigate to 'Store Settings'. 3. Go to the 'API' tab (you may find it under 'Settings' > 'Advanced' if not directly visible). 4. Click 'Create API Key' to generate your unique credentials. The dashboard will display both a 'Store ID' and an 'API Key'. You must record both, as they are required for every API request.

2. Add them to .dlt/secrets.toml

[sources.order_desk_source] ORDERDESK_STORE_ID = "your_store_id" ORDERDESK_API_KEY = "your_api_key"

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 Order-desk data can I load into DuckDB?

These are the Order-desk endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
ordersordersGETordersList multiple orders
orderorders/{order_id}GETorderGet a single order
order_itemsorders/{order_id}/order-itemsGETorder_itemsList items for an order
order_itemorders/{order_id}/order-items/{item_id}GETorder_itemGet a single order item
shipmentsshipmentsGETshipmentsList all shipments
inventory_itemsinventory-itemsGETinventory_itemsGet all inventory items

How do I load only new Order-desk records?

Order-desk exposes offset on 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.

{"name": "orders", "endpoint": { "path": "orders", "data_selector": "orders", "incremental": {"cursor_path": "offset", "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 Order-desk pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading 'orders and inventory_items'},top_results:},top_results:}? from the Order-desk API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def order_desk_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://app.orderdesk.me/api/v2", "auth": {"type": "api_key", "api_key": api_key}, }, "resources": [ {"name": "orders", "endpoint": {"path": "orders", "data_selector": "orders"}}, {"name": "inventory_items", "endpoint": {"path": "inventory-items", "data_selector": "inventory_items"}} ], } yield from rest_api_resources(config) def load_order_desk_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="order_desk_pipeline", destination="duckdb", dataset_name="order_desk_data", ) load_info = pipeline.run(order_desk_source()) print(load_info) if __name__ == "__main__": load_order_desk_to_duckdb()

Run it with python order_desk_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 Order-desk 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):

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

SQL:

SELECT * FROM order_desk_data.orders LIMIT 10;

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


How do I deploy the Order-desk 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 Order-desk 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 Order-desk data to?

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

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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

Was this page helpful?

Community Hub

Need more dlt context for Order-desk to DuckDB?

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