Common Behavior
All import endpoints are asynchronous and return202 Accepted with a job envelope.
string
required
API key with
import:read or import:write scope.Endpoints
Catalog Import
POST /api/import/catalog
array
required
Array of catalog rows.
string
required
Unique product identifier.
string
Product name; defaults to
externalId if omitted.Inventory Import
POST /api/import/inventory
array
required
Array of inventory level rows.
string
required
SKU identifier.
string
required
Location code; internally normalized as
{organizationId}-{locationId}.number
Physical stock on hand. Defaults to
0.number
Reserved quantity. Defaults to
0.number
Threshold used to update internal minimum quantity. Defaults to
0.Suppliers Import
POST /api/import/suppliers
array
required
Array of supplier rows.
string
required
Unique supplier identifier.
Purchase Orders Import
POST /api/import/purchase-orders
array
required
Array of purchase order headers.
string
required
Purchase order number (idempotent key).
string
required
Supplier code.
string
required
Destination location code.
string
Optional PO status, defaults to
PENDING.array
required
PO line rows.
string
required
SKU for the line.
number
required
Line quantity.
number
required
Line unit cost.
Orders Import
POST /api/import/orders
array
required
Array of customer order headers.
string
required
External order identifier.
array
required
Order lines.
string
required
SKU identifier.
number
required
Requested quantity.
string
required
Fulfillment location code.
Demand History Import
POST /api/import/demand-history
array
required
Array of weekly demand history records.
string
required
SKU identifier.
string
required
Location code.
string
required
ISO date used to bucket weekly demand.
string
Channel label; defaults to
ALL.number
Actual units; defaults to
0.number
Forecast units; defaults to
actualDemand.Job Status
Get Job Status
GET /api/import/status/[jobId]
string
Import job ID.
string
Current state (
PENDING, PROCESSING, COMPLETED, FAILED).number
Total rows submitted.
number
Rows processed.
number
Rows rejected.
array
Row-level error details.
string | null
Completion timestamp when available.