Import a historical order

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.

Body Params
integer
required

Historical order reference. Does not have to be unique; duplicates are not prevented.

integer
required

ID of an existing order status in the destination ShopWired account.

string
length ≤ 128

Historical transaction identifier. Maximum 128 bytes. Does not provide duplicate protection.

string
length ≤ 65000

Historical order comments. Maximum 65000 bytes.

string

Historical order creation date. Supply an RFC 2822 date with an explicit timezone offset.

values
object
required
shippingOption
object
billingAddress
object
required
shippingAddress
object
required
products
array of objects
required
length between 1 and 100

Historical product lines. Maximum 100 lines per order.

products*
Responses

401

Unauthorized. Invalid or missing API credentials.

403

Forbidden. The API credentials do not have the write_orders permission.

500

Server error. Reconcile whether an order was created before retrying.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json