Skip to main content

Download Product Mappings CSV

GET 
/api/faire/instances/:integrationInstance/products/csv-mappings

Exports Faire variant → SKU.io product mappings as a CSV file.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

The export is the first half of a round trip: edit the mapped_sku column in a spreadsheet and post the file back to POST .../products/csv-mappings to apply it. The mapped_sku column already carries the CURRENT mapping, so re-uploading an unedited export changes nothing.

scope=unmapped is the most useful starting point — it returns exactly the variants that still have no SKU.io product linked, with an empty mapped_sku column to fill in.

Path Parameters:

  • integrationInstance - Faire integration instance ID.

Columns:

  • faire_variant_id - Faire-issued variant ID. The key the upload matches on.
  • faire_product_name - Parent product name (context only, ignored on upload).
  • faire_variant_name - Variant name (context only, ignored on upload).
  • wholesale_price - Faire wholesale price (context only, ignored on upload).
  • faire_sku - The SKU code Faire holds for the variant (context only, ignored on upload).
  • mapped_sku - The linked SKU.io product code. This is the editable column.

Response: text/csv attachment named faire-product-mappings-{scope}-{YYYY-MM-DD}.csv.

Errors:

  • 422 - No variants matched the requested scope (e.g. every variant is already mapped).

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition