Imports one historical order per request. Requires the write_orders API permission.
Products, variations, choices and extras must already exist in the destination
account. Status and product IDs must be ShopWired IDs, not source-platform IDs.
Shipping rates do not need to exist beforehand.
The basket system is bypassed. Supply accurate historical prices, tax amounts,
VAT rates and totals; these are not recalculated or checked for consistency.
Stock is not updated and order emails are not sent. Order events and webhooks
may still be triggered.
There is no duplicate detection or idempotency protection. Repeating a request
with the same reference or transactionId creates another order. The importing
application must track successful imports and reconcile uncertain outcomes
before retrying.
Customer IDs, currency, discount objects and refund transactions cannot be
supplied through this endpoint. Do not infer historical tax or other missing
financial amounts from current catalogue prices.
String length limits are measured in UTF-8 bytes. The maxLength values below
are upper character limits; multibyte text must also fit the stated byte limit.
Four-byte Unicode characters, including many emoji, are not currently supported
and can cause text to be silently truncated.
401Unauthorized. Invalid or missing API credentials.
403Forbidden. The API credentials do not have the write_orders permission.
500Server error. Reconcile whether an order was created before retrying.