Import Pre-Start-Date Orders
POST/api/woo-commerce/:integrationInstance/pre-start-date-orders/import
Import selected pre-start-date orders from WooCommerce by their WooCommerce order IDs. Full order data is downloaded and stored flagged as a pre-start-date import so it does not affect inventory. Orders that already exist locally are marked instead of duplicated, and cancelled orders are skipped.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Because each order is fetched individually from WooCommerce, the import runs asynchronously as a queued background job. The request returns immediately with a tracked job log id that can be polled to follow the import's progress.
Requires the inventory start date to be set — returns 422 otherwise.
Path Parameters:
integrationInstance- The WooCommerce integration instance ID
Request Body:
woo_commerce_order_ids(required, array of integers, 1-10,000 entries) — WooCommerce order IDs to import.
Response:
data.tracked_job_log_id- id of the tracked job log; poll it to follow import progressmessage- human-readable confirmation of how many orders are being imported
Route name: woo-commerce.pre-start-date-orders.import
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.