Skip to main content
Server path: /faire | Type: Application | PCID required: Yes Wholesale marketplace

Tools

ToolDescription
faire_get_productsGet products from Faire marketplace. Products returned ascending by updated_at.
faire_get_productGet detailed information about a specific product
faire_get_ordersGet orders from Faire. Orders are returned oldest first (ascending by updated_at).
faire_get_orderGet detailed information about a specific order
faire_process_orderMark an order as processing
faire_cancel_orderCancel an order (only if state is NEW, PROCESSING, PENDING_RETAILER_CONFIRMATION, or BACKORDERED)
faire_ship_orderMark an order as shipped with tracking information (moves state to PRE_TRANSIT, then IN_TRANSIT when carrier accepts)
faire_get_packing_slipDownload packing slip PDF for an order
faire_backorder_itemsSet availability for order items (for backordering or marking discontinued)
faire_create_productCreate a new product in Faire marketplace
faire_update_productUpdate an existing product
faire_get_taxonomy_typesGet all available product taxonomy types/categories
faire_create_variantCreate a new product variant
faire_update_variantUpdate an existing product variant
faire_get_inventory_by_skusGet inventory levels by SKU(s)
faire_get_inventory_by_variant_idsGet inventory levels by variant ID(s)
faire_update_inventory_by_skusUpdate inventory levels by SKU(s)
faire_update_inventory_by_variant_idsUpdate inventory levels by variant ID(s)
faire_get_brand_profileGet current brand profile information
faire_get_retailer_infoGet public retailer information

faire_get_products

Get products from Faire marketplace. Products returned ascending by updated_at. Parameters:
ParameterTypeRequiredDefaultDescription
limitnumberNo50Maximum number of products to return (10-250)
pagenumberNoPage number for offset pagination
updated_at_minstringNoISO 8601 timestamp - only return products modified since
skustringNoSKU to search for
include_deletedbooleanNoInclude deleted products in response
cursorstringNoPagination cursor. Cannot be used with updated_at_min, sku, or include_deleted

faire_get_product

Get detailed information about a specific product Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID to retrieve

faire_get_orders

Get orders from Faire. Orders are returned oldest first (ascending by updated_at). Parameters:
ParameterTypeRequiredDefaultDescription
limitnumberNo50Maximum number of orders to return (10-50)
pagenumberNoPage number for offset pagination (first result is (page-1)*limit)
updated_at_minstringNoISO 8601 timestamp - only show orders modified since this time
created_at_minstringNoISO 8601 timestamp - only show orders created since this time
excluded_statesstringNoComma-separated states to exclude (e.g., “DELIVERED,CANCELLED”)
ship_after_maxstringNoISO 8601 timestamp - only show orders due to ship at or before this time
cursorstringNoPagination cursor from previous response. Cannot be used with date filters.

faire_get_order

Get detailed information about a specific order Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID to retrieve

faire_process_order

Mark an order as processing Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID to process
expected_ship_datestringNoISO 8601 timestamp of expected ship date

faire_cancel_order

Cancel an order (only if state is NEW, PROCESSING, PENDING_RETAILER_CONFIRMATION, or BACKORDERED) Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID to cancel
reasonstringYesReason for cancellation (e.g., ITEM_OUT_OF_STOCK)
notestringYesExplanation for retailer (30-1000 characters)

faire_ship_order

Mark an order as shipped with tracking information (moves state to PRE_TRANSIT, then IN_TRANSIT when carrier accepts) Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID to ship
shipmentsobject[]YesArray of shipments to add

faire_get_packing_slip

Download packing slip PDF for an order Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID
timezonestringNoIANA timezone string (e.g., America/New_York), default UTC

faire_backorder_items

Set availability for order items (for backordering or marking discontinued) Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesOrder ID
availabilitiesobjectYesMap keyed by order item ID (oi_xxx). Must set either discontinued=true OR backordered_until

faire_create_product

Create a new product in Faire marketplace Parameters:
ParameterTypeRequiredDefaultDescription
idempotence_tokenstringYesUnique identifier for idempotence
namestringYesProduct name
unit_multipliernumberYesCase size/quantity - product ships in multiples of this
minimum_order_quantitynumberYesMinimum units to purchase (must be multiple of unit_multiplier)
taxonomy_typeobjectYesProduct category/type
variant_option_setsobject[]YesVariant options for this product
variantsany[]YesInitial variants for this product
descriptionstringNoProduct description (max 1000 chars)
short_descriptionstringNoShort description (max 75 chars)
lifecycle_statestringNoLifecycle state
preorderablebooleanNoWhether product can be preordered
made_in_countrystringNoISO 3166-1 alpha-3 country code (e.g., USA, CAN)

faire_update_product

Update an existing product Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID to update
updatesobjectYesFields to update (name, description, taxonomy_type, etc.)

faire_get_taxonomy_types

Get all available product taxonomy types/categories

faire_create_variant

Create a new product variant Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID
idempotence_tokenstringYesUnique identifier for idempotence
skustringYesSKU for this variant
optionsobject[]YesOptions that define this variant (must match product variant_option_sets)
pricesobject[]YesPrices by geography and currency
available_quantitynumberNoAvailable inventory quantity
gtinstringNoGlobal Trade Item Number
tariff_codestringNoHS6 Tariff Code
backordered_untilstringNoISO 8601 timestamp when variant will be back in stock

faire_update_variant

Update an existing product variant Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID
variantIdstringYesVariant ID to update
updatesobjectYesFields to update (name, sku, prices, available_quantity, etc.)

faire_get_inventory_by_skus

Get inventory levels by SKU(s) Parameters:
ParameterTypeRequiredDefaultDescription
skusstring[]YesArray of SKUs to retrieve inventory for

faire_get_inventory_by_variant_ids

Get inventory levels by variant ID(s) Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]YesArray of variant IDs to retrieve inventory for

faire_update_inventory_by_skus

Update inventory levels by SKU(s) Parameters:
ParameterTypeRequiredDefaultDescription
inventoriesobject[]YesArray of inventory updates

faire_update_inventory_by_variant_ids

Update inventory levels by variant ID(s) Parameters:
ParameterTypeRequiredDefaultDescription
inventoriesobject[]YesArray of inventory updates

faire_get_brand_profile

Get current brand profile information

faire_get_retailer_info

Get public retailer information Parameters:
ParameterTypeRequiredDefaultDescription
retailerIdstringYesRetailer ID