Skip to main content
Version: Next (unreleased)

Quick Start

Your first request in two minutes.

1. Create an API key

  1. Open the Datamingle dashboard and sign in.
  2. Go to Settings → API Keys.
  3. Click Create key.
  4. Give it a name (for example, "staging integration"), leave scopes as the default (integrations.*), and click Create.
  5. Copy the key — it's shown once, never again. Save it in your secret manager.

That's the entire setup. No partner configuration, no field mapping, no onboarding call.

2. Verify the key

curl https://<your-tenant>.datamingle.ai/api/integrations/v1/orders/ \
-H "X-API-Key: sk_live_..."

You should get:

{"success": true, "data": []}

If you get 401 or 403, jump to Authentication.

3. Create an order

curl -X POST https://<your-tenant>.datamingle.ai/api/integrations/v1/orders/ \
-H "X-API-Key: sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"order_number": "ORD-001",
"external_order_id": "ERP-5001",
"customer_name": "Acme Corporation",
"items": [
{"sku_code": "RUG-5X7-BLU", "quantity": 10}
]
}'

Returns 201 Created with the full order.

note

sku_code must reference an existing product. Create one via POST /products/ or from the dashboard first.

4. Retrieve, update, cancel

Records are addressed by external_order_id by default.

# Get
curl https://<your-tenant>.datamingle.ai/api/integrations/v1/orders/ERP-5001/ \
-H "X-API-Key: sk_live_..."

# Update (only header fields)
curl -X PUT https://<your-tenant>.datamingle.ai/api/integrations/v1/orders/ERP-5001/ \
-H "X-API-Key: sk_live_..." \
-H "Content-Type: application/json" \
-d '{"notes": "Priority shipping"}'

# Cancel (soft — status moves to "cancelled")
curl -X DELETE https://<your-tenant>.datamingle.ai/api/integrations/v1/orders/ERP-5001/ \
-H "X-API-Key: sk_live_..." \
-H "Content-Type: application/json" \
-d '{"reason": "Customer cancelled"}'

That's it

You've got the whole pattern. Every other resource (inventory, locations, products) follows the same shape. Browse the API Reference for details.

What next?

  • Hit production? Secure the key: rotate regularly, scope tightly.
  • ERP uses different field names? Custom Integrations handles that without touching your code.
  • Need error handling? Errors lists every response.