Skip to main content
This endpoint accepts batched order payloads and creates or updates dcmOrder and dcmOrderLine records for the authenticated organization.

Import Orders

POST /api/import/orders

Authentication

Pass an API key in the request header:
x-api-key
string
required
Import API key with import:write, import:read, or import:* scope.

Request Body

orders
array
required
Array of order rows to import.
Each order row supports:
orders[].externalOrderId
string
required
External order identifier used as the order ID.
orders[].lines
array
required
Order lines for the order.
orders[].lines[].skuId
string
required
Product SKU identifier.
orders[].lines[].quantity
number
required
Requested quantity for the line.
orders[].lines[].locationId
string
required
Source location code (stored as {organizationId}-{locationId}).

Success Response

202 Accepted
jobId
string
Created import job ID.
status
string
Always ACCEPTED when the job is accepted for processing.
rowCount
number
Number of received order rows.

Validation Error

400 Bad Request when orders[] is missing or empty.
{
  "error": "orders[] is required"
}