Faire

📄️List Faire Instances

List all Faire integration instances for this account.

📄️Create Faire Instance

Create a new Faire integration instance.

📄️Get Faire Instance

Retrieve details of a specific Faire integration instance.

📄️Update Faire Instance

Update an existing Faire integration instance.

📄️Preview Financial Line Backfill

Preview how many past Faire-imported FinancialLine rows would be re-keyed if the supplied override map were applied. **Does not modify any data.**

📄️Apply Financial Line Backfill

Re-key past Faire-imported FinancialLine rows to the override types that are **already persisted** on the integration instance. **No request body** — the overrides are read off `integration_settings.financial_line_type_overrides`, which is set via the Update Faire Instance endpoint.

📄️Get OAuth Config

Return the public OAuth metadata used by the frontend to render the authorization flow.

📄️Get Authorization URL

Generate the Faire OAuth authorization URL for this integration instance.

📄️OAuth Callback (Faire → SKU)

OAuth callback hit by Faire after the user authorizes the app. **Not called manually** — Faire redirects the user's browser to this URL.

📄️Revoke Authorization

Revoke the stored Faire access token both at Faire (`POST /api/external-api-oauth2/revoke`) and locally on the integration instance.

📄️Set Access Token Manually

Persist a Faire long-lived access token directly onto the integration instance — an alternative to the OAuth Authorization Code flow.

📄️Reuse Existing Connection

Reuse the connection from another authorized Faire integration instance instead of authorizing again.

📄️Validate Connection

Verify this integration's stored access token against Faire and capture the brand it belongs to.

📄️Sync Orders

Trigger an order sync from Faire for a specific integration instance.

📄️Sync Products

Trigger a product catalog sync from Faire for a specific integration instance.

📄️Sync Inventory

Trigger an inventory sync to push current inventory levels to Faire for a specific integration instance.

📄️List Faire Orders

List Faire orders for a specific integration instance.

📄️Get Faire Order

Get details of a specific Faire order including its line items.

📄️Refetch Order from Faire

Re-fetch the order from the Faire API. Updates local data and (if a linked SKU sales order exists) refreshes the SKU sales order to mirror Faire's latest state. Returns the updated Faire order object (with line_items, sales_order, faire_admin_url).

📄️Get Order Filter Options (Distinct Values)

**Tenant resolution (multi-instance safety):**

📄️Get Orders Latest Sync Info

Aggregate stats about the Faire orders previously synced to this instance. Powers the **Refresh from Faire** orders modal header card and the latest-sync indicator on the orders index.

📄️Refresh Orders from Faire (Tracked)

Dispatches a background job that walks Faire's `/api/v2/orders` endpoint and upserts `faire_orders` + `faire_order_line_items`. Returns immediately with a tracked job log ID — progress is visible via the tracked job log endpoints.

📄️Submit Tracking to Faire (FBM)

Manually retry tracking submission for an FBM Faire order.

📄️Archive Faire Order

Archives a single Faire order — stamps `archived_at = now()` via the `Archive` trait. Archived orders are excluded from the auto-create-SKU-orders pipelines (see `createSkuOrders`) and from the default orders listing (which uses `filter[archived]=` Active by default).

📄️Unarchive Faire Order

Unarchives a single Faire order — clears `archived_at` via the `Archive` trait. After unarchiving, the order becomes eligible for auto-create-SKU-orders again.

📄️Bulk Archive Faire Orders

Archives multiple Faire orders for the given integration instance. Scoped to active orders only — already-archived rows are silently skipped, and IDs from foreign integration instances are NOT affected (the controller filters `where('integration_instance_id', $instance->id)`).

📄️Bulk Unarchive Faire Orders

Unarchives multiple Faire orders for the given integration instance. Scoped to archived orders only — already-active rows are silently skipped, and IDs from foreign integration instances are NOT affected.

📄️Delete Linked Sales Order

Deletes the linked SKU.io sales order for a single Faire order while keeping the Faire order itself intact. Optionally archives the Faire order in the same call to prevent re-creation on the next sync.

📄️Bulk Delete Linked Sales Orders

Bulk-deletes the linked SKU.io sales orders for multiple Faire orders while keeping the Faire orders themselves intact. Only orders with a linked sales order in the targeted integration instance are processed — IDs from foreign instances or without a linked SKU order are silently skipped.

📄️Sync Linked Sales Order

Refetches the order from Faire and synchronously syncs the linked SKU.io sales order's status fields (`order_status`, `payment_status`, `last_synced_from_sales_channel_at`).

📄️Bulk Sync Linked Sales Orders

Bulk-refetches Faire orders and re-syncs each linked SKU.io sales order's status fields (`order_status`, `payment_status`, `last_synced_from_sales_channel_at`). Only orders with a linked SKU sales order in the targeted integration instance are processed — foreign-instance IDs and orders without a linked SKU order are silently skipped.

📄️List 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.

📄️Import Pre-Start-Date Orders

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.

📄️Create Linked Sales Orders

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

📄️List Faire Products

List Faire products synced for a specific integration instance.

📄️List Products for Instance (Variants Listing)

Paginated list of `FaireProductOption` rows (variants) for one Faire integration instance. Powers the **Faire → Products** listing page in application UI.

📄️Get Faire Products Latest Sync Info

Aggregate stats about the products previously synced from Faire. Used by the **Refresh from Faire** modal header to show how much data is currently cached locally and which mode of refresh is appropriate.

📄️Get Variant Filter Options (Distinct Product Types)

Returns distinct values for the variant listing's filter dropdowns. Currently only `product_types` (sourced from `faire_products.product_type`, populated from Faire's taxonomy `taxonomy_type.name`).

📄️Refresh Products from Faire (Tracked)

Dispatches a background job background job that walks the Faire catalog and persists `faire_products` + `faire_product_options`. Returns immediately with a tracked job log ID — progress is visible via the tracked job log endpoints.

📄️Bulk Operation (Synchronous)

Run a bulk action on Faire product options synchronously and return the result inline. Best for **Selected Only** requests where the count is small and the operation completes in well under HTTP timeout. For **All Filtered** requests that may exceed timeout, use the tracked variant instead.

📄️Bulk Operation (Tracked)

Dispatches a background job background job that performs the bulk action across the resolved selection. Returns immediately with a tracked job log ID — progress is visible via the tracked job log endpoints and pollable via the `bulk-progress` endpoint.

📄️Bulk Operation Progress

Returns the live progress of a background job. Returns the standard tracked job log object shape — same as the tracked job log endpoints polls. Poll this endpoint while the job runs; `progress_percentage` and `results` update as the job processes batches.