Version 2026-08 · v1
Shopdesk Commerce API
Read your store’s products, orders, customers, stock and sales channels from your own systems. One header to authenticate, cursor pagination built for syncing, and an error contract your code can branch on.
export SHOPDESK_API_KEY="shopdesk_sk_YOUR_API_KEY"
curl -sS "https://api.shopdeskbd.com/ext/v1/orders?limit=5" \
-H "Authorization: Bearer $SHOPDESK_API_KEY"57
Endpoints
16
Scopes in use
24
Webhook events
Everything in these docs
Getting started
From no key to your first response, in five minutes.
Authentication
Key format, store vs company keys, rotation, revocation.
Build with AI
Markdown twins, llms.txt, the spec URL, and the two MCP servers.
Errors
The error envelope, every code, and what to do with each.
Pagination
Cursor paging, the sync pattern, and why sorting is limited.
Writes & idempotency
Every write endpoint, and the Idempotency-Key contract behind them.
Rate limits
Per-key buckets, headers, and handling 429.
Versioning
What we may change without warning, and what we may not.
Overview
Generated from the published OpenAPI description.
MCP tools
Every store MCP tool — scopes, arguments, metering, output — generated from the tool manifest.
Overview
Outbound events: the envelope, the guarantees, the rules.
Event catalog
Every event type we send, and what each one carries.
Verifying signatures
The signing scheme, code in three languages, and test vectors.
Retries & ordering
The retry ladder, dead deliveries, and auto-disable.
Testing
The shopdesk.ping event and how to develop against it.
Headers
Every header on a delivery, and what to do with it.
Rotating a secret
The dual-signing window, and what a receiver does during it.
Overview
End-to-end recipes for the common integrations.
Create an order
Customer, variants, idempotency key, and what comes back.
Sync inventory to an ERP
Cursors, watermarks and checkpoints that survive a crash.
Handle webhooks idempotently
Verify, dedupe, upsert, and answer fast.
Build a custom storefront
The read path, checkout, and what the API does not give you.
Build a COD confirmation tool
Find the order by phone, confirm or cancel it, schedule the call-back.
Sales and reports
The sales summary, comparisons and top products, and what each figure counts.
Build a catalog through the API
Attributes, a category and a brand, then a product with variants and photos — in four calls.
Photos by link
Where links are taken, what is checked, all-or-nothing calls, limits and safe retries.
Upload a product video
Raw calls from start to finish, covers, a video for one option, imports by link, reject codes and limits.
Changelog
Every change to the public API, newest first.