Skip to main content

Overview

Orders import writes customer orders and order lines for fulfillment workflows. Each order requires an externalOrderId and at least one line.

Quick Start

  1. Build orders[] with order headers and nested lines.
  2. POST to /api/import/orders.
  3. Poll /api/import/status/[jobId].

Header Fields

Better Data FieldTypeRequiredExampleDescription
externalOrderIdstringYESSO-778901Unique order ID (idempotent key).
linesarrayYES[{...}]Order line rows.

Line Fields (lines[])

Better Data FieldTypeRequiredExampleDescription
skuIdstringYESSKU-001Ordered SKU.
quantitynumberYES2Requested quantity.
locationIdstringYESDC-EASTFulfillment location code.

Validation Rules

  • orders[] must be present and non-empty.
  • Header requires externalOrderId and non-empty lines[].
  • Each line should include skuId, quantity, and locationId.

Common Errors

ErrorMeaningHow to fix
orders[] is requiredMissing order array.Send { "orders": [ ... ] }.
required fields missingMissing externalOrderId or no line rows.Provide required header fields and at least one line.