Faire

App · 21 actions

Run your Faire wholesale brand from workflows: pick up new orders, accept them, backorder items, add shipments with tracking and cancel them; keep products, variants, prices and stock in step with your other channels. Start a workflow when an order comes in, changes state, ships or is canceled, or a product changes.

Actions

ActionWhat it does
Accept orderAccept a new order, which moves it to Processing.
Add shipmentAdd a shipment to an order with its carrier and tracking code, which marks the order as shipped.
Backorder itemTell Faire you can't ship all of an item on an order now: how many you can ship, and the day the rest will be ready, or that it's discontinued.
Cancel orderCancel an order that is new, processing, backordered or waiting for the retailer.
Create productAdd a product with one variant: its SKU, wholesale and retail prices and stock.
Create variantAdd a variant, such as another size or colour, to a product, with its SKU, prices and stock.
Delete productDelete a product.
Delete variantDelete one of a product's variants.
Get brand profileGet your brand's name, ID, the currency you sell in and your locale.
Get orderGet an order with its items, the address it ships to, its payout and its shipments.
Get productGet a product with its type, images and every variant's SKU, prices and stock, even if it was deleted.
Get retailerGet the store behind an order: its name, and whether it's a Faire Insider.
Get stockGet how many of each SKU you have on hand, how many are promised to orders, and how many retailers can still order.
Get variantGet one of a product's variants by its ID or SKU, with its options, prices and stock.
List ordersList your Faire orders, oldest change first, by state and date.
List product typesList Faire's product types, which every product is filed under, with their IDs.
List productsList your Faire products with their variants, oldest change first.
List variantsList a product's variants with their SKUs, options, prices and stock.
Set stockSet how many of a SKU you have on hand, such as after a stock count or a sale elsewhere.
Update productChange a product's name, descriptions, type, state or how it's sold.
Update variantChange a variant's SKU, prices, state or the day it's back in stock.

Accept order

Accept a new order, which moves it to Processing. Faire tells the retailer you've accepted it.

Inputs

OrderordertextRequired
The order's ID (it starts with bo_), from the trigger or another Faire step.
Expected ship dateexpected_ship_datedate
When you expect to ship it, which Faire shows the retailer.

Outputs

created_attext
When it was placed (ISO 8601)
currencytext
The currency, such as USD
customer_nametext
The name of the person who placed it
display_idtext
The order number Faire shows
expected_ship_datetext
When it's expected to ship (ISO 8601)
idtext
The order's ID, such as bo_bxdmjbwxid
item_countnumber
How many different items it has
itemslist
What was ordered
notestext
The retailer's notes or special requests for you
purchase_order_numbertext
The retailer's purchase order number, if given
retailer_idtext
The retailer's ID; 'Get retailer' gives their store
ship_aftertext
The retailer's earliest ship date (ISO 8601); empty if none
ship_to_address1text
The street address
ship_to_address2text
The second address line
ship_to_citytext
The city
ship_to_companytext
The store or company it ships to
ship_to_countrytext
The country's three-letter code, such as CAN
ship_to_nametext
Who it ships to
ship_to_phonetext
The phone number to ship to
ship_to_postal_codetext
The postal code
ship_to_statetext
The state or province code, such as ON
shipmentslist
The shipments added to it
statetext
Its state: NEW, PROCESSING, PRE_TRANSIT, IN_TRANSIT, DELIVERED, PENDING_RETAILER_CONFIRMATION, BACKORDERED or CANCELED
state_labeltext
Its state in words, such as Processing
subtotalnumber
The items' wholesale value: each price times its quantity
total_payoutnumber
What Faire pays you for it; 0 if Faire doesn't say yet
total_quantitynumber
How many units in all
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "customer_name": "John Smith",
  "display_id": "BXDMJBWXID",
  "expected_ship_date": "2026-11-12T00:00:00.000Z",
  "id": "bo_bxdmjbwxid",
  "item_count": 1,
  "items": [
    {
      "currency": "USD",
      "id": "oi_bq425ju5vh",
      "price": 49.99,
      "product_id": "p_fccaefnahr",
      "product_name": "Golden Dog",
      "quantity": 2,
      "sku": "goldenretriever",
      "state": "NEW",
      "variant_id": "po_3745tjzrpc",
      "variant_name": ""
    }
  ],
  "notes": "Please include a handwritten thank-you note",
  "purchase_order_number": "12345",
  "retailer_id": "r_c9385ldj",
  "ship_after": "",
  "ship_to_address1": "41 King Street West",
  "ship_to_address2": "3rd Floor",
  "ship_to_city": "Kitchener",
  "ship_to_company": "Faire Wholesale, Inc",
  "ship_to_country": "CAN",
  "ship_to_name": "John Smith",
  "ship_to_phone": "555-123-4567",
  "ship_to_postal_code": "N2G 1A1",
  "ship_to_state": "ON",
  "shipments": [],
  "state": "NEW",
  "state_label": "New",
  "subtotal": 99.98,
  "total_payout": 80.0,
  "total_quantity": 2,
  "updated_at": "2026-11-05T09:00:00.000Z"
}

Add shipment

Add a shipment to an order with its carrier and tracking code, which marks the order as shipped. Faire sends the retailer the tracking.

Inputs

OrderordertextRequired
The order's ID (it starts with bo_), from the trigger or another Faire step.
CarriercarriertextRequired
Who is carrying it. For another carrier, add the shipment in Faire instead.One of: UPS, USPS, FEDEX, DHL_EXPRESS (DHL Express), DHL_ECOMMERCE (DHL eCommerce), CANADA_POST (Canada Post), PUROLATOR, CANPAR, ROYAL_MAIL (Royal Mail), PARCELFORCE, and 8 more.
Tracking codetracking_codetextRequired
The carrier's tracking code.
Shipping costshipping_costnumberRequired
What you paid to ship it, such as 12.40.At least 0.
Currencycurrencytext
The shipping cost's currency. Leave blank for the one your brand sells in.One of: USD (US dollars (USD), for the United States), CAD (Canadian dollars (CAD), for Canada), GBP (Pounds (GBP), for the United Kingdom), EUR (Euros (EUR), for the European Union), AUD (Australian dollars (AUD), for Australia).

Outputs

created_attext
When it was placed (ISO 8601)
currencytext
The currency, such as USD
customer_nametext
The name of the person who placed it
display_idtext
The order number Faire shows
expected_ship_datetext
When it's expected to ship (ISO 8601)
idtext
The order's ID, such as bo_bxdmjbwxid
item_countnumber
How many different items it has
itemslist
What was ordered
notestext
The retailer's notes or special requests for you
purchase_order_numbertext
The retailer's purchase order number, if given
retailer_idtext
The retailer's ID; 'Get retailer' gives their store
ship_aftertext
The retailer's earliest ship date (ISO 8601); empty if none
ship_to_address1text
The street address
ship_to_address2text
The second address line
ship_to_citytext
The city
ship_to_companytext
The store or company it ships to
ship_to_countrytext
The country's three-letter code, such as CAN
ship_to_nametext
Who it ships to
ship_to_phonetext
The phone number to ship to
ship_to_postal_codetext
The postal code
ship_to_statetext
The state or province code, such as ON
shipmentslist
The shipments added to it
statetext
Its state: NEW, PROCESSING, PRE_TRANSIT, IN_TRANSIT, DELIVERED, PENDING_RETAILER_CONFIRMATION, BACKORDERED or CANCELED
state_labeltext
Its state in words, such as Processing
subtotalnumber
The items' wholesale value: each price times its quantity
total_payoutnumber
What Faire pays you for it; 0 if Faire doesn't say yet
total_quantitynumber
How many units in all
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "customer_name": "John Smith",
  "display_id": "BXDMJBWXID",
  "expected_ship_date": "2026-11-12T00:00:00.000Z",
  "id": "bo_bxdmjbwxid",
  "item_count": 1,
  "items": [
    {
      "currency": "USD",
      "id": "oi_bq425ju5vh",
      "price": 49.99,
      "product_id": "p_fccaefnahr",
      "product_name": "Golden Dog",
      "quantity": 2,
      "sku": "goldenretriever",
      "state": "NEW",
      "variant_id": "po_3745tjzrpc",
      "variant_name": ""
    }
  ],
  "notes": "Please include a handwritten thank-you note",
  "purchase_order_number": "12345",
  "retailer_id": "r_c9385ldj",
  "ship_after": "",
  "ship_to_address1": "41 King Street West",
  "ship_to_address2": "3rd Floor",
  "ship_to_city": "Kitchener",
  "ship_to_company": "Faire Wholesale, Inc",
  "ship_to_country": "CAN",
  "ship_to_name": "John Smith",
  "ship_to_phone": "555-123-4567",
  "ship_to_postal_code": "N2G 1A1",
  "ship_to_state": "ON",
  "shipments": [],
  "state": "NEW",
  "state_label": "New",
  "subtotal": 99.98,
  "total_payout": 80.0,
  "total_quantity": 2,
  "updated_at": "2026-11-05T09:00:00.000Z"
}

Backorder item

Tell Faire you can't ship all of an item on an order now: how many you can ship, and the day the rest will be ready, or that it's discontinued. Faire asks the retailer whether to wait.

Inputs

OrderordertextRequired
The order's ID (it starts with bo_), from the trigger or another Faire step.
ItemitemtextRequired
The order item's ID (it starts with oi_), or its SKU on this order.
Can ship nowavailable_quantitynumber
How many of the item you can ship now. Leave blank for none.At least 0.
Ready onbackordered_untildate
The day the rest will be ready to ship. Needed unless the item is discontinued.
Discontinueddiscontinuedtrue/false
Turn on if you'll never have the rest.

Outputs

created_attext
When it was placed (ISO 8601)
currencytext
The currency, such as USD
customer_nametext
The name of the person who placed it
display_idtext
The order number Faire shows
expected_ship_datetext
When it's expected to ship (ISO 8601)
idtext
The order's ID, such as bo_bxdmjbwxid
item_countnumber
How many different items it has
itemslist
What was ordered
notestext
The retailer's notes or special requests for you
purchase_order_numbertext
The retailer's purchase order number, if given
retailer_idtext
The retailer's ID; 'Get retailer' gives their store
ship_aftertext
The retailer's earliest ship date (ISO 8601); empty if none
ship_to_address1text
The street address
ship_to_address2text
The second address line
ship_to_citytext
The city
ship_to_companytext
The store or company it ships to
ship_to_countrytext
The country's three-letter code, such as CAN
ship_to_nametext
Who it ships to
ship_to_phonetext
The phone number to ship to
ship_to_postal_codetext
The postal code
ship_to_statetext
The state or province code, such as ON
shipmentslist
The shipments added to it
statetext
Its state: NEW, PROCESSING, PRE_TRANSIT, IN_TRANSIT, DELIVERED, PENDING_RETAILER_CONFIRMATION, BACKORDERED or CANCELED
state_labeltext
Its state in words, such as Processing
subtotalnumber
The items' wholesale value: each price times its quantity
total_payoutnumber
What Faire pays you for it; 0 if Faire doesn't say yet
total_quantitynumber
How many units in all
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "customer_name": "John Smith",
  "display_id": "BXDMJBWXID",
  "expected_ship_date": "2026-11-12T00:00:00.000Z",
  "id": "bo_bxdmjbwxid",
  "item_count": 1,
  "items": [
    {
      "currency": "USD",
      "id": "oi_bq425ju5vh",
      "price": 49.99,
      "product_id": "p_fccaefnahr",
      "product_name": "Golden Dog",
      "quantity": 2,
      "sku": "goldenretriever",
      "state": "NEW",
      "variant_id": "po_3745tjzrpc",
      "variant_name": ""
    }
  ],
  "notes": "Please include a handwritten thank-you note",
  "purchase_order_number": "12345",
  "retailer_id": "r_c9385ldj",
  "ship_after": "",
  "ship_to_address1": "41 King Street West",
  "ship_to_address2": "3rd Floor",
  "ship_to_city": "Kitchener",
  "ship_to_company": "Faire Wholesale, Inc",
  "ship_to_country": "CAN",
  "ship_to_name": "John Smith",
  "ship_to_phone": "555-123-4567",
  "ship_to_postal_code": "N2G 1A1",
  "ship_to_state": "ON",
  "shipments": [],
  "state": "NEW",
  "state_label": "New",
  "subtotal": 99.98,
  "total_payout": 80.0,
  "total_quantity": 2,
  "updated_at": "2026-11-05T09:00:00.000Z"
}

Cancel order

Cancel an order that is new, processing, backordered or waiting for the retailer. Faire tells the retailer why, with your note. This can't be undone.

Inputs

OrderordertextRequired
The order's ID (it starts with bo_), from the trigger or another Faire step.
ReasonreasontextRequired
Why you're canceling.One of: ITEM_OUT_OF_STOCK (Items are out of stock), REQUESTED_BY_RETAILER (The retailer asked to cancel), CHANGE_REPLACE_ORDER (The retailer wants to change or replace the order), RETAILER_NOT_GOOD_FIT (The retailer isn't a good fit), INCORRECT_PRICING (Items are priced wrongly), ORDER_TOO_SMALL (The order is too small), REJECT_INTERNATIONAL_ORDER (You don't sell in the retailer's country), OTHER (Another reason).
Note to the retailernotetextRequired
Why you're canceling, in your words: 30 to 1,000 characters. Faire shows it to the retailer.

Outputs

created_attext
When it was placed (ISO 8601)
currencytext
The currency, such as USD
customer_nametext
The name of the person who placed it
display_idtext
The order number Faire shows
expected_ship_datetext
When it's expected to ship (ISO 8601)
idtext
The order's ID, such as bo_bxdmjbwxid
item_countnumber
How many different items it has
itemslist
What was ordered
notestext
The retailer's notes or special requests for you
purchase_order_numbertext
The retailer's purchase order number, if given
retailer_idtext
The retailer's ID; 'Get retailer' gives their store
ship_aftertext
The retailer's earliest ship date (ISO 8601); empty if none
ship_to_address1text
The street address
ship_to_address2text
The second address line
ship_to_citytext
The city
ship_to_companytext
The store or company it ships to
ship_to_countrytext
The country's three-letter code, such as CAN
ship_to_nametext
Who it ships to
ship_to_phonetext
The phone number to ship to
ship_to_postal_codetext
The postal code
ship_to_statetext
The state or province code, such as ON
shipmentslist
The shipments added to it
statetext
Its state: NEW, PROCESSING, PRE_TRANSIT, IN_TRANSIT, DELIVERED, PENDING_RETAILER_CONFIRMATION, BACKORDERED or CANCELED
state_labeltext
Its state in words, such as Processing
subtotalnumber
The items' wholesale value: each price times its quantity
total_payoutnumber
What Faire pays you for it; 0 if Faire doesn't say yet
total_quantitynumber
How many units in all
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "customer_name": "John Smith",
  "display_id": "BXDMJBWXID",
  "expected_ship_date": "2026-11-12T00:00:00.000Z",
  "id": "bo_bxdmjbwxid",
  "item_count": 1,
  "items": [
    {
      "currency": "USD",
      "id": "oi_bq425ju5vh",
      "price": 49.99,
      "product_id": "p_fccaefnahr",
      "product_name": "Golden Dog",
      "quantity": 2,
      "sku": "goldenretriever",
      "state": "NEW",
      "variant_id": "po_3745tjzrpc",
      "variant_name": ""
    }
  ],
  "notes": "Please include a handwritten thank-you note",
  "purchase_order_number": "12345",
  "retailer_id": "r_c9385ldj",
  "ship_after": "",
  "ship_to_address1": "41 King Street West",
  "ship_to_address2": "3rd Floor",
  "ship_to_city": "Kitchener",
  "ship_to_company": "Faire Wholesale, Inc",
  "ship_to_country": "CAN",
  "ship_to_name": "John Smith",
  "ship_to_phone": "555-123-4567",
  "ship_to_postal_code": "N2G 1A1",
  "ship_to_state": "ON",
  "shipments": [],
  "state": "NEW",
  "state_label": "New",
  "subtotal": 99.98,
  "total_payout": 80.0,
  "total_quantity": 2,
  "updated_at": "2026-11-05T09:00:00.000Z"
}

Create product

Add a product with one variant: its SKU, wholesale and retail prices and stock. It starts as a draft unless you publish it. Add more variants with 'Create variant'.

Inputs

NamenametextRequired
What the product is called.
Product typeproduct_typetextRequired
The kind of product, such as Votive Candle.
SKUskutextRequired
The product's SKU.
Wholesale pricewholesale_pricenumberRequired
What retailers pay for one, such as 12.50.At least 0.
Retail priceretail_pricenumberRequired
The price you suggest retailers sell one at, such as 25.At least 0.
Currencycurrencytext
The prices' currency. Leave blank for the one your brand sells in.One of: USD (US dollars (USD), for the United States), CAD (Canadian dollars (CAD), for Canada), GBP (Pounds (GBP), for the United Kingdom), EUR (Euros (EUR), for the European Union), AUD (Australian dollars (AUD), for Australia).
Statestatetext
Whether retailers can see it yet. A published product needs an image.One of: DRAFT (Draft: not shown to retailers), PUBLISHED (Published: retailers can order it). Default: DRAFT.
Descriptiondescriptiontext
What retailers read about it.
Short descriptionshort_descriptiontext
A line about it, up to 255 characters.
Stockavailable_quantitynumber
How many you have to sell.At least 0.
Image addressesimage_urlslist
Web addresses of its images, starting with https://.
Sold in packs ofunit_multipliernumber
How many units retailers buy at a time, such as 6. Leave blank for one.At least 1.
Minimum orderminimum_order_quantitynumber
The fewest units a retailer can order, a whole number of packs. Leave blank for one pack.At least 0.
Optionoption_nametext
What its variants differ by, such as Scent or Size. It can't be added later, so give it if you'll add variants.
This variant's optionoption_valuetext
This first variant's value of that option, such as Vanilla.

Outputs

created_attext
When it was added (ISO 8601)
descriptiontext
Its description
idtext
The product's ID, such as p_fccaefnahr
image_urlslist
Its images' addresses
lifecycle_statetext
PUBLISHED, DRAFT, UNPUBLISHED or DELETED
minimum_order_quantitynumber
The fewest a retailer can order
nametext
Its name
product_typetext
Its product type, such as Votive Candle
product_type_idtext
Its product type's ID, such as tt_23nl3bzl00
sale_statetext
Whether it's for sale, such as FOR_SALE
short_descriptiontext
Its short description
unit_multipliernumber
How many units it's sold in at a time
updated_attext
When it last changed (ISO 8601)
variant_countnumber
How many variants it has
variantslist
Its variants
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "description": "Glad you decided to read our description!",
  "id": "p_fccaefnahr",
  "image_urls": [
    "https://cdn.example.com/candle.jpg"
  ],
  "lifecycle_state": "PUBLISHED",
  "minimum_order_quantity": 8,
  "name": "Faire's fantastic candle",
  "product_type": "Votive Candle",
  "product_type_id": "tt_23nl3bzl00",
  "sale_state": "FOR_SALE",
  "short_description": "Our candles smell fantastic.",
  "unit_multiplier": 8,
  "updated_at": "2026-11-05T09:00:00.000Z",
  "variant_count": 1,
  "variants": [
    {
      "available_quantity": 24,
      "backordered_until": "",
      "created_at": "2026-11-05T09:00:00.000Z",
      "currency": "USD",
      "id": "po_3745tjzrpc",
      "lifecycle_state": "PUBLISHED",
      "name": "Vanilla",
      "options": {
        "Scent": "Vanilla"
      },
      "prices": [
        {
          "country": "USA",
          "country_group": "",
          "currency": "USD",
          "retail_price": 10.0,
          "wholesale_price": 5.0
        }
      ],
      "product_id": "p_fccaefnahr",
      "retail_price": 10.0,
      "sale_state": "FOR_SALE",
      "sku": "vanilla-candle",
      "tariff_code": "",
      "updated_at": "2026-11-05T09:00:00.000Z",
      "wholesale_price": 5.0
    }
  ]
}

Create variant

Add a variant, such as another size or colour, to a product, with its SKU, prices and stock.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).
SKUskutextRequired
The variant's SKU.
Namenametext
The variant's name, such as Large.
Optionsoptionsobject
Its options by name, such as {"Size": "Large"}, using the product's own option names. A new value is added to the product for you.
Wholesale pricewholesale_pricenumberRequired
What retailers pay for one, such as 12.50.At least 0.
Retail priceretail_pricenumberRequired
The price you suggest retailers sell one at, such as 25.At least 0.
Currencycurrencytext
The prices' currency. Leave blank for the one your brand sells in.One of: USD (US dollars (USD), for the United States), CAD (Canadian dollars (CAD), for Canada), GBP (Pounds (GBP), for the United Kingdom), EUR (Euros (EUR), for the European Union), AUD (Australian dollars (AUD), for Australia).
Stockavailable_quantitynumber
How many you have to sell.At least 0.
Image addressesimage_urlslist
Web addresses of its images, starting with https://.

Outputs

available_quantitynumber
How many Faire shows as available
backordered_untiltext
When it's back in stock (ISO 8601); empty if not
created_attext
When it was added (ISO 8601)
currencytext
Those prices' currency
idtext
The variant's ID, such as po_3745tjzrpc
lifecycle_statetext
PUBLISHED, DRAFT, UNPUBLISHED or DELETED
nametext
Its name, if it has one
optionsobject
Its options by name, such as {"Scent": "Vanilla"}
priceslist
Its prices for each country or group of countries
product_idtext
Its product's ID
retail_pricenumber
Its suggested retail price, from its first price
sale_statetext
Whether it's for sale, such as FOR_SALE
skutext
Its SKU
tariff_codetext
Its tariff (HS) code
updated_attext
When it last changed (ISO 8601)
wholesale_pricenumber
Its wholesale price, from its first price
Example output
{
  "available_quantity": 24,
  "backordered_until": "",
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "id": "po_3745tjzrpc",
  "lifecycle_state": "PUBLISHED",
  "name": "Vanilla",
  "options": {
    "Scent": "Vanilla"
  },
  "prices": [
    {
      "country": "USA",
      "country_group": "",
      "currency": "USD",
      "retail_price": 10.0,
      "wholesale_price": 5.0
    }
  ],
  "product_id": "p_fccaefnahr",
  "retail_price": 10.0,
  "sale_state": "FOR_SALE",
  "sku": "vanilla-candle",
  "tariff_code": "",
  "updated_at": "2026-11-05T09:00:00.000Z",
  "wholesale_price": 5.0
}

Delete product

Delete a product. Faire marks it deleted and retailers no longer see it; this can't be undone here.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).

Outputs

deletedtrue/false
True once deleted
idtext
The ID of what was deleted
Example output
{
  "deleted": true,
  "id": "p_fccaefnahr"
}

Delete variant

Delete one of a product's variants. A product keeps at least one: to remove the last, delete the product.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).
VariantvarianttextRequired
The variant to delete. Pick one, or give its ID or SKU.

Outputs

deletedtrue/false
True once deleted
idtext
The ID of what was deleted
Example output
{
  "deleted": true,
  "id": "po_3745tjzrpc"
}

Get brand profile

Get your brand's name, ID, the currency you sell in and your locale.

Inputs

None.

Outputs

brand_idtext
Your brand's ID
currencytext
The currency you sell in, such as USD
localetext
Your brand's locale, such as en-US
nametext
Your brand's name
Example output
{
  "brand_id": "b_60ae65c4",
  "currency": "USD",
  "locale": "en-US",
  "name": "Jeff's Warm Toques"
}

Get order

Get an order with its items, the address it ships to, its payout and its shipments.

Inputs

OrderordertextRequired
The order's ID (it starts with bo_), from the trigger or another Faire step.

Outputs

created_attext
When it was placed (ISO 8601)
currencytext
The currency, such as USD
customer_nametext
The name of the person who placed it
display_idtext
The order number Faire shows
expected_ship_datetext
When it's expected to ship (ISO 8601)
idtext
The order's ID, such as bo_bxdmjbwxid
item_countnumber
How many different items it has
itemslist
What was ordered
notestext
The retailer's notes or special requests for you
purchase_order_numbertext
The retailer's purchase order number, if given
retailer_idtext
The retailer's ID; 'Get retailer' gives their store
ship_aftertext
The retailer's earliest ship date (ISO 8601); empty if none
ship_to_address1text
The street address
ship_to_address2text
The second address line
ship_to_citytext
The city
ship_to_companytext
The store or company it ships to
ship_to_countrytext
The country's three-letter code, such as CAN
ship_to_nametext
Who it ships to
ship_to_phonetext
The phone number to ship to
ship_to_postal_codetext
The postal code
ship_to_statetext
The state or province code, such as ON
shipmentslist
The shipments added to it
statetext
Its state: NEW, PROCESSING, PRE_TRANSIT, IN_TRANSIT, DELIVERED, PENDING_RETAILER_CONFIRMATION, BACKORDERED or CANCELED
state_labeltext
Its state in words, such as Processing
subtotalnumber
The items' wholesale value: each price times its quantity
total_payoutnumber
What Faire pays you for it; 0 if Faire doesn't say yet
total_quantitynumber
How many units in all
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "customer_name": "John Smith",
  "display_id": "BXDMJBWXID",
  "expected_ship_date": "2026-11-12T00:00:00.000Z",
  "id": "bo_bxdmjbwxid",
  "item_count": 1,
  "items": [
    {
      "currency": "USD",
      "id": "oi_bq425ju5vh",
      "price": 49.99,
      "product_id": "p_fccaefnahr",
      "product_name": "Golden Dog",
      "quantity": 2,
      "sku": "goldenretriever",
      "state": "NEW",
      "variant_id": "po_3745tjzrpc",
      "variant_name": ""
    }
  ],
  "notes": "Please include a handwritten thank-you note",
  "purchase_order_number": "12345",
  "retailer_id": "r_c9385ldj",
  "ship_after": "",
  "ship_to_address1": "41 King Street West",
  "ship_to_address2": "3rd Floor",
  "ship_to_city": "Kitchener",
  "ship_to_company": "Faire Wholesale, Inc",
  "ship_to_country": "CAN",
  "ship_to_name": "John Smith",
  "ship_to_phone": "555-123-4567",
  "ship_to_postal_code": "N2G 1A1",
  "ship_to_state": "ON",
  "shipments": [],
  "state": "NEW",
  "state_label": "New",
  "subtotal": 99.98,
  "total_payout": 80.0,
  "total_quantity": 2,
  "updated_at": "2026-11-05T09:00:00.000Z"
}

Get product

Get a product with its type, images and every variant's SKU, prices and stock, even if it was deleted.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).

Outputs

created_attext
When it was added (ISO 8601)
descriptiontext
Its description
idtext
The product's ID, such as p_fccaefnahr
image_urlslist
Its images' addresses
lifecycle_statetext
PUBLISHED, DRAFT, UNPUBLISHED or DELETED
minimum_order_quantitynumber
The fewest a retailer can order
nametext
Its name
product_typetext
Its product type, such as Votive Candle
product_type_idtext
Its product type's ID, such as tt_23nl3bzl00
sale_statetext
Whether it's for sale, such as FOR_SALE
short_descriptiontext
Its short description
unit_multipliernumber
How many units it's sold in at a time
updated_attext
When it last changed (ISO 8601)
variant_countnumber
How many variants it has
variantslist
Its variants
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "description": "Glad you decided to read our description!",
  "id": "p_fccaefnahr",
  "image_urls": [
    "https://cdn.example.com/candle.jpg"
  ],
  "lifecycle_state": "PUBLISHED",
  "minimum_order_quantity": 8,
  "name": "Faire's fantastic candle",
  "product_type": "Votive Candle",
  "product_type_id": "tt_23nl3bzl00",
  "sale_state": "FOR_SALE",
  "short_description": "Our candles smell fantastic.",
  "unit_multiplier": 8,
  "updated_at": "2026-11-05T09:00:00.000Z",
  "variant_count": 1,
  "variants": [
    {
      "available_quantity": 24,
      "backordered_until": "",
      "created_at": "2026-11-05T09:00:00.000Z",
      "currency": "USD",
      "id": "po_3745tjzrpc",
      "lifecycle_state": "PUBLISHED",
      "name": "Vanilla",
      "options": {
        "Scent": "Vanilla"
      },
      "prices": [
        {
          "country": "USA",
          "country_group": "",
          "currency": "USD",
          "retail_price": 10.0,
          "wholesale_price": 5.0
        }
      ],
      "product_id": "p_fccaefnahr",
      "retail_price": 10.0,
      "sale_state": "FOR_SALE",
      "sku": "vanilla-candle",
      "tariff_code": "",
      "updated_at": "2026-11-05T09:00:00.000Z",
      "wholesale_price": 5.0
    }
  ]
}

Get retailer

Get the store behind an order: its name, and whether it's a Faire Insider.

Inputs

RetailerretailertextRequired
The retailer's ID (it starts with r_), such as an order's retailer ID.

Outputs

is_insidertrue/false
True if the retailer has an active Faire Insider membership
nametext
Their store's name
retailer_idtext
The retailer's ID
Example output
{
  "is_insider": true,
  "name": "Faire Wholesale, Inc",
  "retailer_id": "r_c9385ldj"
}

Get stock

Get how many of each SKU you have on hand, how many are promised to orders, and how many retailers can still order.

Inputs

SKUsskuslistRequired
The SKUs to look up. Pick them, or type them.

Outputs

countnumber
How many SKUs are listed
inventorieslist
Each SKU's stock
Example output
{
  "count": 1,
  "inventories": [
    {
      "available_quantity": 20,
      "committed_quantity": 4,
      "on_hand_quantity": 24,
      "sku": "vanilla-candle",
      "tracked": true
    }
  ]
}

Get variant

Get one of a product's variants by its ID or SKU, with its options, prices and stock.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).
VariantvarianttextRequired
The variant. Pick one, or give its ID or SKU.

Outputs

available_quantitynumber
How many Faire shows as available
backordered_untiltext
When it's back in stock (ISO 8601); empty if not
created_attext
When it was added (ISO 8601)
currencytext
Those prices' currency
idtext
The variant's ID, such as po_3745tjzrpc
lifecycle_statetext
PUBLISHED, DRAFT, UNPUBLISHED or DELETED
nametext
Its name, if it has one
optionsobject
Its options by name, such as {"Scent": "Vanilla"}
priceslist
Its prices for each country or group of countries
product_idtext
Its product's ID
retail_pricenumber
Its suggested retail price, from its first price
sale_statetext
Whether it's for sale, such as FOR_SALE
skutext
Its SKU
tariff_codetext
Its tariff (HS) code
updated_attext
When it last changed (ISO 8601)
wholesale_pricenumber
Its wholesale price, from its first price
Example output
{
  "available_quantity": 24,
  "backordered_until": "",
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "id": "po_3745tjzrpc",
  "lifecycle_state": "PUBLISHED",
  "name": "Vanilla",
  "options": {
    "Scent": "Vanilla"
  },
  "prices": [
    {
      "country": "USA",
      "country_group": "",
      "currency": "USD",
      "retail_price": 10.0,
      "wholesale_price": 5.0
    }
  ],
  "product_id": "p_fccaefnahr",
  "retail_price": 10.0,
  "sale_state": "FOR_SALE",
  "sku": "vanilla-candle",
  "tariff_code": "",
  "updated_at": "2026-11-05T09:00:00.000Z",
  "wholesale_price": 5.0
}

List orders

List your Faire orders, oldest change first, by state and date. Gets one page; to see more, run it again with the next page.

Inputs

Statesstateslist
Only orders in these states. Leave blank for every state.One or more of: NEW, PROCESSING, PRE_TRANSIT (Pre-transit), IN_TRANSIT (In transit), DELIVERED, PENDING_RETAILER_CONFIRMATION (Waiting for the retailer to confirm), BACKORDERED, CANCELED.
Placed aftercreated_afterdate and time
Only orders placed at or after this time.
Changed afterupdated_afterdate and time
Only orders that changed at or after this time.
Can ship byship_after_beforedate and time
Only orders the retailer lets you ship by this time: their earliest ship date is no later.
Sort bysort_bytext
List them by when they last changed or when they were placed, oldest first.One of: UPDATED_AT (Last change), CREATED_AT (When placed). Default: UPDATED_AT.
How manylimitnumber
How many to list on this page, from 10 to 50. Defaults to 50.From 10 to 50.
Pagepagenumber
Which page to list, starting at 1. Use the next number when the last answer said there may be more.At least 1.

Outputs

countnumber
How many are listed
has_moretrue/false
True when there may be another page
orderslist
The orders found, oldest change first
pagenumber
The page these are
Example output
{
  "count": 1,
  "has_more": false,
  "orders": [
    {
      "created_at": "2026-11-05T09:00:00.000Z",
      "currency": "USD",
      "customer_name": "John Smith",
      "display_id": "BXDMJBWXID",
      "expected_ship_date": "2026-11-12T00:00:00.000Z",
      "id": "bo_bxdmjbwxid",
      "item_count": 1,
      "items": [
        {
          "currency": "USD",
          "id": "oi_bq425ju5vh",
          "price": 49.99,
          "product_id": "p_fccaefnahr",
          "product_name": "Golden Dog",
          "quantity": 2,
          "sku": "goldenretriever",
          "state": "NEW",
          "variant_id": "po_3745tjzrpc",
          "variant_name": ""
        }
      ],
      "notes": "Please include a handwritten thank-you note",
      "purchase_order_number": "12345",
      "retailer_id": "r_c9385ldj",
      "ship_after": "",
      "ship_to_address1": "41 King Street West",
      "ship_to_address2": "3rd Floor",
      "ship_to_city": "Kitchener",
      "ship_to_company": "Faire Wholesale, Inc",
      "ship_to_country": "CAN",
      "ship_to_name": "John Smith",
      "ship_to_phone": "555-123-4567",
      "ship_to_postal_code": "N2G 1A1",
      "ship_to_state": "ON",
      "shipments": [],
      "state": "NEW",
      "state_label": "New",
      "subtotal": 99.98,
      "total_payout": 80.0,
      "total_quantity": 2,
      "updated_at": "2026-11-05T09:00:00.000Z"
    }
  ],
  "page": 1
}

List product types

List Faire's product types, which every product is filed under, with their IDs.

Inputs

Name containssearchtext
Only types whose name has these words, such as candle.

Outputs

countnumber
How many are listed
product_typeslist
Faire's product types
Example output
{
  "count": 1,
  "product_types": [
    {
      "id": "tt_23nl3bzl00",
      "name": "Votive Candle"
    }
  ]
}

List products

List your Faire products with their variants, oldest change first. Gets one page; to see more, run it again with the next page.

Inputs

SKUskutext
Only the product with a variant of this SKU.
Changed afterupdated_afterdate and time
Only products that changed at or after this time.
Include deletedinclude_deletedtrue/false
Turn on to list deleted products too.
How manylimitnumber
How many to list on this page, from 10 to 250. Defaults to 50.From 10 to 250.
Pagepagenumber
Which page to list, starting at 1. Use the next number when the last answer said there may be more.At least 1.

Outputs

countnumber
How many are listed
has_moretrue/false
True when there may be another page
pagenumber
The page these are
productslist
The products found, oldest change first
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "products": [
    {
      "created_at": "2026-11-05T09:00:00.000Z",
      "description": "Glad you decided to read our description!",
      "id": "p_fccaefnahr",
      "image_urls": [
        "https://cdn.example.com/candle.jpg"
      ],
      "lifecycle_state": "PUBLISHED",
      "minimum_order_quantity": 8,
      "name": "Faire's fantastic candle",
      "product_type": "Votive Candle",
      "product_type_id": "tt_23nl3bzl00",
      "sale_state": "FOR_SALE",
      "short_description": "Our candles smell fantastic.",
      "unit_multiplier": 8,
      "updated_at": "2026-11-05T09:00:00.000Z",
      "variant_count": 1,
      "variants": [
        {
          "available_quantity": 24,
          "backordered_until": "",
          "created_at": "2026-11-05T09:00:00.000Z",
          "currency": "USD",
          "id": "po_3745tjzrpc",
          "lifecycle_state": "PUBLISHED",
          "name": "Vanilla",
          "options": {
            "Scent": "Vanilla"
          },
          "prices": [
            {
              "country": "USA",
              "country_group": "",
              "currency": "USD",
              "retail_price": 10.0,
              "wholesale_price": 5.0
            }
          ],
          "product_id": "p_fccaefnahr",
          "retail_price": 10.0,
          "sale_state": "FOR_SALE",
          "sku": "vanilla-candle",
          "tariff_code": "",
          "updated_at": "2026-11-05T09:00:00.000Z",
          "wholesale_price": 5.0
        }
      ]
    }
  ]
}

List variants

List a product's variants with their SKUs, options, prices and stock.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).

Outputs

countnumber
How many it has
product_idtext
The product's ID
product_nametext
The product's name
variantslist
Its variants
Example output
{
  "count": 1,
  "product_id": "p_fccaefnahr",
  "product_name": "Faire's fantastic candle",
  "variants": [
    {
      "available_quantity": 24,
      "backordered_until": "",
      "created_at": "2026-11-05T09:00:00.000Z",
      "currency": "USD",
      "id": "po_3745tjzrpc",
      "lifecycle_state": "PUBLISHED",
      "name": "Vanilla",
      "options": {
        "Scent": "Vanilla"
      },
      "prices": [
        {
          "country": "USA",
          "country_group": "",
          "currency": "USD",
          "retail_price": 10.0,
          "wholesale_price": 5.0
        }
      ],
      "product_id": "p_fccaefnahr",
      "retail_price": 10.0,
      "sale_state": "FOR_SALE",
      "sku": "vanilla-candle",
      "tariff_code": "",
      "updated_at": "2026-11-05T09:00:00.000Z",
      "wholesale_price": 5.0
    }
  ]
}

Set stock

Set how many of a SKU you have on hand, such as after a stock count or a sale elsewhere. Faire works out what retailers can order.

Inputs

SKUskutextRequired
The SKU. Pick one, or type it.
On handon_hand_quantitynumberRequired
How many you have.At least 0.

Outputs

available_quantitynumber
How many retailers can still order (on hand less committed); empty when untracked
committed_quantitynumber
How many are promised to orders
on_hand_quantitynumber
How many you have; empty when untracked
skutext
The SKU
trackedtrue/false
False when Faire doesn't count this SKU's stock
Example output
{
  "available_quantity": 20,
  "committed_quantity": 4,
  "on_hand_quantity": 24,
  "sku": "vanilla-candle",
  "tracked": true
}

Update product

Change a product's name, descriptions, type, state or how it's sold. Fields left blank keep what it has.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).
Namenametext
A new name. Leave blank to keep it.
Descriptiondescriptiontext
A new description. Leave blank to keep it.
Short descriptionshort_descriptiontext
A new line about it, up to 255 characters. Leave blank to keep it.
Statestatetext
Publish it, hide it or make it a draft. Leave blank to keep it.One of: DRAFT (Draft: not shown to retailers), PUBLISHED (Published: retailers can order it), UNPUBLISHED (Unpublished: hidden from retailers).
Product typeproduct_typetext
A new product type. Leave blank to keep it.
Sold in packs ofunit_multipliernumber
How many units retailers buy at a time. Leave blank to keep it.At least 1.
Minimum orderminimum_order_quantitynumber
The fewest units a retailer can order. Leave blank to keep it.At least 0.

Outputs

created_attext
When it was added (ISO 8601)
descriptiontext
Its description
idtext
The product's ID, such as p_fccaefnahr
image_urlslist
Its images' addresses
lifecycle_statetext
PUBLISHED, DRAFT, UNPUBLISHED or DELETED
minimum_order_quantitynumber
The fewest a retailer can order
nametext
Its name
product_typetext
Its product type, such as Votive Candle
product_type_idtext
Its product type's ID, such as tt_23nl3bzl00
sale_statetext
Whether it's for sale, such as FOR_SALE
short_descriptiontext
Its short description
unit_multipliernumber
How many units it's sold in at a time
updated_attext
When it last changed (ISO 8601)
variant_countnumber
How many variants it has
variantslist
Its variants
Example output
{
  "created_at": "2026-11-05T09:00:00.000Z",
  "description": "Glad you decided to read our description!",
  "id": "p_fccaefnahr",
  "image_urls": [
    "https://cdn.example.com/candle.jpg"
  ],
  "lifecycle_state": "PUBLISHED",
  "minimum_order_quantity": 8,
  "name": "Faire's fantastic candle",
  "product_type": "Votive Candle",
  "product_type_id": "tt_23nl3bzl00",
  "sale_state": "FOR_SALE",
  "short_description": "Our candles smell fantastic.",
  "unit_multiplier": 8,
  "updated_at": "2026-11-05T09:00:00.000Z",
  "variant_count": 1,
  "variants": [
    {
      "available_quantity": 24,
      "backordered_until": "",
      "created_at": "2026-11-05T09:00:00.000Z",
      "currency": "USD",
      "id": "po_3745tjzrpc",
      "lifecycle_state": "PUBLISHED",
      "name": "Vanilla",
      "options": {
        "Scent": "Vanilla"
      },
      "prices": [
        {
          "country": "USA",
          "country_group": "",
          "currency": "USD",
          "retail_price": 10.0,
          "wholesale_price": 5.0
        }
      ],
      "product_id": "p_fccaefnahr",
      "retail_price": 10.0,
      "sale_state": "FOR_SALE",
      "sku": "vanilla-candle",
      "tariff_code": "",
      "updated_at": "2026-11-05T09:00:00.000Z",
      "wholesale_price": 5.0
    }
  ]
}

Update variant

Change a variant's SKU, prices, state or the day it's back in stock. Prices in other currencies are kept. Fields left blank keep what it has.

Inputs

ProductproducttextRequired
The product. Pick one, or give its ID (it starts with p_).
VariantvarianttextRequired
The variant to change. Pick one, or give its ID or SKU.
SKUskutext
A new SKU. Leave blank to keep it.
Wholesale pricewholesale_pricenumber
What retailers pay for one, such as 12.50. Leave blank to keep it.At least 0.
Retail priceretail_pricenumber
The price you suggest retailers sell one at, such as 25. Leave blank to keep it.At least 0.
Currencycurrencytext
Which prices to change. Leave blank for the currency your brand sells in.One of: USD (US dollars (USD), for the United States), CAD (Canadian dollars (CAD), for Canada), GBP (Pounds (GBP), for the United Kingdom), EUR (Euros (EUR), for the European Union), AUD (Australian dollars (AUD), for Australia).
Statestatetext
Publish it, hide it or make it a draft. Leave blank to keep it.One of: DRAFT (Draft: not shown to retailers), PUBLISHED (Published: retailers can order it), UNPUBLISHED (Unpublished: hidden from retailers).
Back in stock onbackordered_untildate
The day it will be back in stock, while it's out.
Tariff codetariff_codetext
Its customs tariff (HS) code, such as 3406.00.

Outputs

available_quantitynumber
How many Faire shows as available
backordered_untiltext
When it's back in stock (ISO 8601); empty if not
created_attext
When it was added (ISO 8601)
currencytext
Those prices' currency
idtext
The variant's ID, such as po_3745tjzrpc
lifecycle_statetext
PUBLISHED, DRAFT, UNPUBLISHED or DELETED
nametext
Its name, if it has one
optionsobject
Its options by name, such as {"Scent": "Vanilla"}
priceslist
Its prices for each country or group of countries
product_idtext
Its product's ID
retail_pricenumber
Its suggested retail price, from its first price
sale_statetext
Whether it's for sale, such as FOR_SALE
skutext
Its SKU
tariff_codetext
Its tariff (HS) code
updated_attext
When it last changed (ISO 8601)
wholesale_pricenumber
Its wholesale price, from its first price
Example output
{
  "available_quantity": 24,
  "backordered_until": "",
  "created_at": "2026-11-05T09:00:00.000Z",
  "currency": "USD",
  "id": "po_3745tjzrpc",
  "lifecycle_state": "PUBLISHED",
  "name": "Vanilla",
  "options": {
    "Scent": "Vanilla"
  },
  "prices": [
    {
      "country": "USA",
      "country_group": "",
      "currency": "USD",
      "retail_price": 10.0,
      "wholesale_price": 5.0
    }
  ],
  "product_id": "p_fccaefnahr",
  "retail_price": 10.0,
  "sale_state": "FOR_SALE",
  "sku": "vanilla-candle",
  "tariff_code": "",
  "updated_at": "2026-11-05T09:00:00.000Z",
  "wholesale_price": 5.0
}

On this page