Retailers

GET /retailers/public/{retailer_id}

This endpoint retrieves information about a retailer given their ID. Use the isUpmarketPlusRetailer field to determine whether the retailer requires a packing slip in every shipping package when fulfilling their orders.

get/retailers/public/{retailer_id}

Request

Base URL
https://www.faire.com/external-api/v2
Auth
API key in header X-FAIRE-OAUTH-ACCESS-TOKEN and API key in header X-FAIRE-APP-CREDENTIALS
TypeScript
https://skmtc.dev/faire/apis/faire-external-api/docs/retailers/public/:retailer_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

retailer_idstring required

Response

Successful response

retailer_idstring

A unique identifier for the retailer.

namestring

The name of the retailer's business.

is_insiderboolean

Indicates whether this retailer currently has an active Faire Insider membership. This field is true if the retailer has an active isInsider membership (TRIALING or ACTIVE status), and false otherwise (no membership, or CANCELLED/UNPAID/PAUSED status).

is_upmarket_plus_retailerboolean

Indicates whether this retailer is an Upmarket Plus retailer.

Example response

{
  "retailer_id": "r_c9385ldj",
  "name": "Faire Wholesale, Inc",
  "is_insider": true,
  "is_upmarket_plus_retailer": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.