Skip to main content

Get Variant Detail

GET 
/api/faire/instances/:integrationInstance/products/:option

Detail view of a single FaireProductOption (variant), powering the Faire variant detail page in Vue 3.

Eager-loaded relationships:

  • product — parent FaireProduct (status, product_type, image_url, wholesale_price_minimum, currency_code, brand_name, description)
  • product.options.productListing.product.defaultFinancialLineType — sibling variants and their sku.io mapping
  • productListing.product.defaultFinancialLineType — the sku.io product this variant is mapped to (if any)

Response shape (FaireProductOptionResource):

  • id, integration_instance_id, faire_product_id, faire_variant_id, sku, name
  • product_name, product_status, product_type, product_image_url — copied from parent product
  • product_brand_name, product_description — derived from the parent FaireProduct.raw_data JSON via Eloquent accessors (Faire does not store these as dedicated columns)
  • product_wholesale_price_minimum, product_currency_code
  • inventory_quantity, faire_inventory_quantity, wholesale_price
  • product — { id, sku, name, type, default_financial_line_type_id, default_financial_line_type } of the mapped sku.io product (null if unmapped). type is the SKU.io products.type value (single, variation, etc.).
  • sibling_options[] — other variants on the same FaireProduct, each with their own mapping status; sibling product_listing_product now includes type as well
  • archived_at — ISO timestamp; non-null indicates the variant is archived
  • created_at, updated_at — ISO timestamps

Note: Faire's full raw_data payload is NOT included here for performance reasons. Fetch it on-demand via GET /api/faire/instances/:integrationInstance/products/:option/raw.\n\nNote: faire_product_id is the Faire-issued product ID (e.g. p_3bz2tdhtkq), sourced from the parent FaireProduct. It is NOT the internal faire_product_options.faire_product_id foreign key.

Request​

Responses​

Successful response