Skip to main content

Update Faire Instance

PUT 
/api/faire/instances/:integrationInstance

Update an existing Faire integration instance.

Path Parameters:

  • integrationInstance - The ID of the integration instance

Partial Updates: All fields are optional (use sometimes validation). Only the fields you provide will be updated:

  • name - New display name (max 255 chars)
  • order_import_start_date - New import start date (or null to remove)
  • is_automatic_sync_enabled - Toggle automatic background sync (boolean)
  • auto_create_products - Auto-create local products from Faire feed (boolean)
  • default_shipping_method_id - ID of the shipping method applied to every sales order imported from Faire. Faire never provides a shipping method on its orders, so this default is used for all imports. Pass null to clear the default. The response includes a hydrated default_shipping_method object (id, method_name, full_name, carrier_name) when set.
  • inventory.masterOfStock - sku.io or Neither
  • inventory.selectedWarehouses[] - Array of warehouse IDs whose stock contributes to the Faire inventory feed
  • inventory.inventoryModificationRules - Min/max/buffer rules for the published inventory quantities
  • financial_line_type_overrides - Optional object overriding the FinancialLineType used for the Faire-specific lines created on each imported order. All keys are optional; pass null to clear an override. Classification is enforced on each branch — see below:
    • commission - FinancialLineType ID (must be a cost type). Applied to the marketplace fee Faire deducts on each order. Default branch creates/uses Faire Commission (cost).
    • payout_fee - FinancialLineType ID (must be a cost type). Applied to the per-payout processing fee Faire takes. Default branch creates/uses Faire Payout Fee (cost).
    • payout_protection_fee - FinancialLineType ID (must be a cost type). Applied when Faire deducts a payout-protection insurance charge on an order. Default branch creates/uses Faire Payout Protection Fee (cost).
    • damaged_and_missing_items - FinancialLineType ID (must be a cost type). Applied when Faire deducts an adjustment for damaged or missing items on a delivered order. Default branch creates/uses Faire Damaged & Missing Items (cost).
    • covered_shipping - FinancialLineType ID (must be a revenue type). Applied when Faire reimburses shipping cost on covered orders. Default branch creates/uses Faire-Covered Shipping (revenue).
    • Validation: Mismatched classification (e.g., a revenue type passed for commission) returns 422 with errors.financial_line_type_overrides.<branch>.

Note: fulfillment_mode is fixed at creation time and ignored on update.

Response: Returns the updated integration instance, including the resolved financial_line_type_overrides object (each branch is either null if no override is configured, or { id, name, classification }).

Request​

Responses​

Successful response