Skip to main content

Create Linked Sales Orders

POST 
/api/faire/instances/:integrationInstance/create-sku-orders

Create SKU.io sales orders from Faire orders that do not yet have a linked sales order.

Authorization

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

Path Parameters:

  • integrationInstance - The ID of the integration instance

Request Body:

  • ids (required unless create_all_orders is true, array of integers) - Internal Faire order IDs (the id from List Faire Orders, not the Faire order ID string)
  • create_all_orders (optional, boolean) - When true, targets every eligible Faire order on the instance and ids is ignored

Eligibility: Only Faire orders belonging to this instance, without an existing linked sales order, and not archived are processed. Ineligible IDs are silently skipped.

Behavior:

  • Exactly 1 eligible order — the sales order is created synchronously within the request
  • 2+ eligible orders — a background job is dispatched and the request returns immediately; creation runs asynchronously and progress can be monitored via the returned tracked_job_log_id
  • 0 eligible orders — returns a No orders to create message

Response:

  • message - Outcome summary
  • tracked_job_log_id - ID for monitoring the background creation (only when 2+ orders are queued)
  • total_orders - Number of orders queued for creation (only when 2+ orders are queued)

Request​

Responses​

OK

Response Headers
    Content-Type