Skip to main content

Download Product Mappings (CSV)

GET 
/api/shopify/:integrationInstance/product-mappings/csv/download

Downloads every Shopify variant on the instance as a CSV file for bulk mapping. Columns: shopify_variant_id, shopify_product_title, shopify_variant_title, price, shopify_sku, mapped_sku.

Not yet available to API tokens

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

Unmapped variants are included with an empty mapped_sku — those are the rows to fill in. Edit the mapped_sku column and re-upload via Upload Product Mappings (CSV); clearing mapped_sku unmaps the variant. Archived variants are excluded unless an archived filter is supplied.

Accepts the same filter parameters as the product listing endpoint, so the file contains exactly the rows that listing would return for the same query. Omit them all to export the whole instance. Pagination and sort parameters are ignored: the export always streams the complete filtered set in primary-key order.

A channel with nothing mapped yet returns the header-only template rather than an error, so the file can be used to start mapping from scratch.

Authentication: Requires Bearer token.

The response is a text/csv file download, not JSON. The row tally is reported in response headers: X-Export-Row-Count (total data rows), X-Export-Mapped-Count, and X-Export-Unmapped-Count.

Request​

Responses​

OK

Response Headers
    Content-Type
    X-Export-Row-Count
    X-Export-Mapped-Count
    X-Export-Unmapped-Count