Skip to main content

Get Product Field Mappings

GET 
/api/faire/instances/:integrationInstance/mappings

Get the product field mappings for a Faire integration instance. Mappings control which Faire listing/variant fields populate which SKU.io product fields when a SKU.io product is created from a Faire variant.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Default mappings (sku → sku, name → item_name, wholesale_price → the default pricing tier) are merged with per-instance custom mappings; a custom mapping targeting the same SKU.io field overrides the default.

Path Parameters:

  • integrationInstance - The ID of the integration instance

Response:

  • integration_instance_id - The integration instance ID
  • integration_name - The integration instance name
  • mappings - The effective mapping list (defaults merged with custom overrides)
  • available_faire_fields - Faire fields that can be used as a mapping source (name, brand_name, description, sku, wholesale_price), each with name, label, type, description, and group
  • available_sku_fields - SKU.io product fields that can be mapped to: static fields (sku, name, item_name, barcode, description, unit_cost, weight, weight_unit, brand) plus dynamic pricing-tier fields (price.{tier}.value) and product attribute fields (attributes.{name})
  • default_mappings - The built-in defaults (each with source: "default")
  • custom_mappings - Per-instance overrides saved via the update endpoint (each with source: "custom")
  • effective_mappings - Same merged list as mappings

Each mapping entry has:

  • listing_field - The Faire source field
  • sku_field - The SKU.io destination field
  • parsers - Optional value-transformation rules applied in order
  • source - default or custom
  • description - Human-readable summary of the mapping

Request​

Responses​

OK

Response Headers
    Content-Type