Identifiers

Retrieve, update, and delete requests address a record by your identifier, not the platform's internal UUID:

GET    /api/integrations/v1/orders/{identifier}/
PUT    /api/integrations/v1/orders/{identifier}/
DELETE /api/integrations/v1/orders/{identifier}/

Which field {identifier} resolves to is chosen by you in the dashboard.

Resolution order

1. Per-resource override — a field mapping may define a specific identifier_field for that resource. Used as-is; you're explicitly opting in.

2. Partner default — otherwise the partner's default_identifier_field is used, but only if it names a real field on the target resource. If not (e.g. a partner configured for orders addresses products), the platform falls through to the next step.

3. Platform default — a built-in per-resource fallback:

   Resource	Fallback field
   Orders	order_number
   Products	sku
   Locations	code

API keys without a linked partner use the platform default directly — steps 1 and 2 are skipped.

Configure partner defaults and per-resource overrides from the dashboard — see Creating partners.

Examples

Default: external_order_id

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

When creating orders, include external_order_id in the payload so you can address the record later:

{
  "order_number": "ORD-001",
  "external_order_id": "ERP-5001",
  "items": [...]
}

Different identifiers per resource

A partner may use different strategies per resource type:

Resource	Identifier field	Example URL
Orders	external_order_id	/orders/ERP-5001/
Locations	code	/locations/A-101/
Products	sku	/products/RUG-5X7-BLU/
Inventory	code (location code)	/inventory/A-101/

URL-encode special characters

If an identifier contains /, space, or other reserved characters, encode it:

# Identifier: "WH/SHELF-01"
curl https://<your-tenant>.datamingle.ai/api/integrations/v1/locations/WH%2FSHELF-01/ \
  -H "X-API-Key: sk_live_..."