Load Shipday data to DuckDB
Build a Shipday to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Shipday API base URL, auth, endpoints, and incremental loading.
Shipday is a delivery management platform that allows users to programmatically manage delivery and pickup orders, drivers, and on-demand delivery network integrations. Everything needed to build a working Shipday → 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 Shipday to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Shipday 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 Shipday 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.
Shipday API at a glance
| Base URL | https://api.shipday.com |
| Example endpoint | GET orders/query |
| Authentication | all requests require HTTP Basic authentication via the Authorization header — sent in the Authorization header, prefixed Basic |
| Pagination | Offset-based |
| Incremental field | startCursor |
| Record id | orderId |
| API reference | https://docs.shipday.com/reference/authentication |
These values come from the Shipday API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Shipday API?
The API uses HTTP Basic authentication where the API key is passed as the credential in the Authorization header. Specifically, the header value should be formatted as 'Basic {API_KEY}' (e.g., 'Authorization: Basic YOUR_API_KEY').
1. Get your credentials
- Log in to your Shipday Dispatch Dashboard (https://dispatch.shipday.com). 2. Navigate to the 'Integrations' section. 3. Select 'API Credentials'. 4. Click 'Show API Key' to reveal your key, then click 'Copy API Key' to copy it to your clipboard.
2. Add them to .dlt/secrets.toml
[sources.shipday_source] api_key = "your_api_key_here"
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 Shipday data can I load into DuckDB?
These are the Shipday endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| orders | /orders | GET | Retrieve active orders. | |
| orders_query | /orders/query | GET | Query delivery orders with filters. | |
| member_orders | /members/{companyId}/completedOrders | GET | Retrieve orders completed by a member. | |
| order_edit | /order/edit/{orderId} | PUT | Edit an existing order. | |
| order_delete | /orders/{orderId} | DELETE | Delete an order by orderId. |
How do I load only new Shipday records?
Shipday exposes startCursor on orders/query, 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_query", "endpoint": { "path": "orders/query", "incremental": {"cursor_path": "startCursor", "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 Shipday pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading /orders and /delivery-orders from the Shipday API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def shipday_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.shipday.com", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "orders_query", "endpoint": {"path": "orders/query"}}, {"name": "member_orders", "endpoint": {"path": "members/{companyId}/completedOrders"}} ], } yield from rest_api_resources(config) def load_shipday_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="shipday_pipeline", destination="duckdb", dataset_name="shipday_data", ) load_info = pipeline.run(shipday_source()) print(load_info) if __name__ == "__main__": load_shipday_to_duckdb()
Run it with python shipday_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 Shipday 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("shipday_pipeline").dataset() df = data.orders_query.df() print(df.head())
SQL:
SELECT * FROM shipday_data.orders_query LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Shipday 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 Shipday loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load Shipday data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example 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 Shipday to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.