Reference · built on requestConnectorCommerce & orders

Faire

Wholesale orders, item availability, shipments, inventory, and payout costs for a brand on Faire through the External API v2.

About

Faire is a wholesale marketplace where retailers order from brands. A brand's account holds orders placed by retailers, the products and variants those orders reference, on-hand and committed inventory, and payout costs per order. The External API v2 at www.faire.com/external-api/v2 serves this data and lets a brand accept, ship, or cancel an order and set inventory by SKU.

Through Fibric, an operator reads orders by updated_at, then proposes what a brand does next: accept into PROCESSING, mark items backordered, add a shipment with tracking, or correct on-hand stock. You approve. The connector calls once and leaves a record: what changed, why, and how to undo it.

This is a reference listing. It documents what Fibric would read from Faire and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Orders through GET /orders, sorted by updated_at with cursor paging, filtered by updated_at_min, excluded_states, and ship_after_max
  • Order state: NEW, PROCESSING, PRE_TRANSIT, IN_TRANSIT, DELIVERED, CANCELED, BACKORDERED, or PENDING_RETAILER_CONFIRMATION, plus item states such as RETURNED and DAMAGED_OR_MISSING
  • Ship timing on each order: ship_after, requested_ship_date, expected_ship_date, and has_pending_retailer_cancellation_request
  • Payout costs per order: commission_bps, payout_fee, total_payout, payment_initiated_at, and estimated_payout_at
  • Shipments with carrier, tracking_code, shipping_type, and shipping_label_url, and the packing slip through GET /orders/{order_id}/packing-slip-pdf
  • Inventory by SKU or variant id: on_hand_quantity, committed_quantity, and available_quantity through GET /product-inventory/by-skus
  • Retailer profiles through GET /retailers/public/{retailer_id}, including whether the retailer is Upmarket Plus

Proposed actions

  • Target capability: propose accepting an order through PUT /orders/{order_id}/processing
  • Target capability: propose item availability changes through POST /orders/{order_id}/items/availability: quantity, discontinued, or backordered per variant
  • Target capability: propose adding shipments through POST /orders/{order_id}/shipments with carrier and tracking_code, which moves the order to PRE_TRANSIT
  • Target capability: propose cancelling an order through PUT /orders/{order_id}/cancel with a reason such as ITEM_OUT_OF_STOCK and a note to the retailer
  • Target capability: propose on-hand inventory updates through PATCH /product-inventory/by-skus, with accept_partial_success for mixed batches

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Backorder before the ship date slips

    When a variant's available_quantity cannot cover an order's items, the operator proposes marking those items backordered through items/availability and a note to the retailer. You approve before anything changes.

    With Backorder Notice

  • Ship inside the promised window

    The operator watches ship_after and requested_ship_date on PROCESSING orders and lists the ones due today, with the packing slip PDF attached for the picker.

    With Promise Date

  • Tracking back to Faire

    When your carrier issues a label, the operator proposes POST /orders/{order_id}/shipments with the carrier and tracking_code so the order moves to PRE_TRANSIT and the retailer sees it.

    With Tracking Sync

  • Tie payouts to orders

    Once payment_initiated_at is set, the operator matches total_payout, commission, and payout_fee to your ledger and flags orders whose payout differs from what was expected.

    With Payout Reconciliation

Requirements

  • A Faire brand account, and an application registered in the Faire Developer Portal with an applicationId and applicationSecret
  • Permissions granted at authorization: READ_ORDERS and WRITE_ORDERS, READ_INVENTORIES and WRITE_INVENTORIES, READ_SHIPMENTS, READ_RETAILER
  • Exchange of the authorization code within 10 minutes at POST /api/external-api-oauth2/token
  • A unique token on every create request, which Faire requires so a retried request does not create a duplicate
Authentication
An OAuth 2.0 authorization-code token sent as X-FAIRE-OAUTH-ACCESS-TOKEN together with X-FAIRE-APP-CREDENTIALS, the Base64 of applicationId:applicationSecret.

Limits

  • No webhooks are documented. Order changes are found by polling GET /orders with updated_at_min and following the cursor.
  • Cancellation is allowed only from NEW, PROCESSING, PENDING_RETAILER_CONFIRMATION, or BACKORDERED, and the note must run 30 to 1000 characters.
  • Paging past the first page without a cursor falls back to offset paging, which Faire rate limits.
  • Payout costs can change until payment_initiated_at is set, for example when items are removed from an order.

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Faire ↗

Questions and answers

Does Faire push order events?
The External API v2 documentation describes no webhooks. The connector polls GET /orders, ordered by updated_at, with updated_at_min and the cursor from the previous response. State changes show up in the order's state field and in item states.
When can an order be cancelled through the API?
Only while its state is NEW, PROCESSING, PENDING_RETAILER_CONFIRMATION, or BACKORDERED. The request names a reason, such as REQUESTED_BY_RETAILER or ITEM_OUT_OF_STOCK, and a note to the retailer of 30 to 1000 characters.
How is inventory represented?
Per variant, as on_hand_quantity, committed_quantity for unfulfilled orders, and available_quantity, defined as on hand minus committed. PATCH /product-inventory/by-skus sets on-hand levels; a separate PATCH under /product-inventory/available sets available levels directly.
Ask about Faire

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.