Skip to main content

Create Faire Instance

POST 
/api/faire/instances

Create a new Faire integration instance.

Required Fields:

  • name - Display name for this instance (max 255 chars)
  • fulfillment_mode - fbm (fulfilled by merchant) or fbf (fulfilled by Faire)

Optional Fields:

  • order_import_start_date - Only import orders created on or after this date
  • warehouse_id - Link to an internal warehouse for inventory and fulfillment

OAuth Authorization: After creation, the instance is unauthorized (is_authorized: false). The frontend must:

  1. Call GET /api/faire/instances/{id}/authorization-url to obtain the Faire OAuth redirect URL.
  2. Redirect the user (who must be a Faire brand admin) to that URL.
  3. Faire redirects back to GET /faire/callback, which exchanges the authorization code for a long-lived access token and persists it.

Response: Returns the created integration instance with is_authorized: false and granted_scopes: [].

Request​

Responses​

Successful response