Skip to main content
POST
/
api
/
v1
/
orders
Notify system that an order has been created (ingestion)
curl --request POST \
  --url https://integrations.polinate.ai/api/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>' \
  --data '
{
  "orderId": "ord_123",
  "businessId": "{{businessId}}"
}
'
{
  "success": true
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

​
Idempotency-Key
string

Idempotency key for POST operations

Example:

"{{idempotencyKey}}"

Body

application/json
​
orderId
string
required
​
businessId
string
required

Response

Accepted

​
success
boolean
required