Skip to main content

Update Product Field Mappings

PUT 
/api/faire/instances/:integrationInstance/mappings

Update the custom product field mappings for a Faire integration instance. The submitted array replaces the instance's entire custom mapping set — include every custom mapping you want to keep.

Authorization

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

Custom mappings override the built-in defaults when they target the same SKU.io field; defaults remain in effect for any SKU.io field not covered by a custom mapping.

Path Parameters:

  • integrationInstance - The ID of the integration instance

Request Body:

  • mappings (required, array) - The custom mapping list
  • mappings[].listing_field (required, string) - Faire source field: name, brand_name, description, sku, or wholesale_price
  • mappings[].sku_field (required, string) - SKU.io destination field: a static field (sku, name, item_name, barcode, description, unit_cost, weight, weight_unit, brand), a pricing-tier field (price.{tier}.value), or an attribute field (attributes.{name})
  • mappings[].parsers (optional, array) - Value-transformation rules applied in order when the mapping is resolved; each entry has a rule name and args

Response:

  • data.integration_instance_id - The integration instance ID
  • data.integration_name - The integration instance name
  • data.mappings - The new effective mapping list (defaults merged with the saved custom mappings)
  • data.effective_mappings - Same merged list as mappings
  • message - Confirmation message

Request​

Responses​

OK

Response Headers
    Content-Type