Skip to main content

Import Pre-Start-Date Orders

POST 
/api/faire/instances/:integrationInstance/pre-start-date-orders/import

Import selected pre-start-date orders from Faire into SKU.io. Each order is fetched from the Faire API and stored as a Faire order flagged as a pre-start-date import.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Because each order requires its own throttled Faire API call, the import runs in the background. The request returns immediately with a tracked job log ID that can be used to follow the import's progress.

Requires the instance's order import start date to be set — returns 422 otherwise.

Path Parameters:

  • integrationInstance - The ID of the integration instance

Request Body:

  • faire_order_ids (required, array of strings, 1-10000 entries) - Faire order IDs to import (e.g. bo_abc123xyz)

Behavior:

  • Runs as a background import — the request returns right away with a tracked job log ID; the orders are fetched and stored asynchronously
  • Orders already in SKU.io are marked as pre-start-date imports instead of being re-imported
  • Cancelled orders and orders whose fulfillment mode does not match the instance are skipped
  • Imported orders do NOT automatically create linked sales orders — use Create Linked Sales Orders afterwards

Response:

  • data.tracked_job_log_id - ID of the tracked job log; poll it to follow import progress
  • message - Human-readable confirmation of how many orders are being imported

Request​

Responses​

OK

Response Headers
    Content-Type