Skip to main content

List Pre-Start-Date Orders

GET 
/api/faire/instances/:integrationInstance/pre-start-date-orders

Query Faire live for orders placed before the instance's order import start date, so historical orders can be selectively imported. Results come directly from the Faire API — not from the local database — and each order carries eligibility flags for import.

Authorization

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

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

Path Parameters:

  • integrationInstance - The ID of the integration instance

Query Parameters:

  • created_at_min (optional, date) - Lower bound for the query window. Defaults to one year before the order import start date

Behavior:

  • Scans up to 10 pages of 50 orders from Faire and keeps only orders created before the start date
  • Cancelled orders and orders already imported into SKU.io are marked ineligible
  • Order totals are read from Faire payout data, falling back to a sum of line item prices when Faire returns zero

Response:

  • data - The queried orders, each with:
    • faire_order_id - Faire order ID (e.g. bo_abc123xyz)
    • display_id - Short human-readable Faire order number
    • status - Faire order state (e.g. DELIVERED, CANCELED)
    • retailer_name - Retailer/company name from the order address
    • ordered_at - When the order was placed on Faire
    • total - Order subtotal in minor currency units (cents); null when unavailable
    • currency_code - Currency of the total (default USD)
    • item_count - Total units across all line items
    • already_imported - True when the order already exists in SKU.io
    • eligible - True when the order can be imported
    • ineligible_reason - Why the order cannot be imported (null when eligible)
    • items - Line items with faire_line_item_id, sku, name, quantity, unit_price (major units)
  • order_import_start_date - The instance's configured start date
  • meta.total_queried / meta.eligible_count / meta.already_imported_count - Query summary counts

Request​

Responses​

OK

Response Headers
    Content-Type