Create Faire Instance

POST 
/api/faire/instances

Create a new Faire integration instance.

Authorization

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

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

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.