Skip to main content

Export Products

GET 
/api/veracore/integration-instances/:integration_instance/products/export

Download the mirrored Veracore offer catalogue as a spreadsheet.

Not yet available to API tokens

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

The response is a file download (.xlsx or .csv), not JSON.

This export is the first half of a round trip: the file is edited offline and uploaded back through the generic data-import endpoints with entity veracore_product_mappings, which reads the Item and SKU.io SKU columns to move mappings. Because of that, Item and SKU.io SKU are always emitted even when columns does not ask for them — a column preference can never produce a file the importer cannot read.

Query parameters

  • format — xlsx (default) or csv
  • scope — which rows to include:
    • filtered (default) — every row matching the filter[...]/sort params sent alongside, i.e. exactly what the table is showing
    • all — the whole catalogue; filter/sort params are deliberately ignored
    • current_page — only the rows on the requested page (honours page/per_page)
    • selected — only the ids listed in ids, still subject to the filters
  • ids — comma-separated veracore_products.id values; only read when scope=selected
  • columns — comma-separated column keys to include. Omit for all 13. Unknown keys are ignored; veracore_product_id and sku_product_id are always prepended.

filter[...], sort, page and per_page accept the same values as GET .../products — the export runs the identical query pipeline so it can never disagree with the screen the user pressed Export on.

Column keys → headings veracore_product_id → Item · title → Title · sku_product_id → SKU.io SKU · product_name → SKU.io Product · mapping_state → Mapping (Mapped / Mapped (manual) / Needs review / Unmapped) · owner_id → Owner · unit_of_measure → UOM · product_type → Product Type · status → Status · is_multi_product_offer → Multi-Product Offer (Yes/No) · bom_product_count → BOM Products · lot_tracked → Lot Tracked (Yes/No) · last_synced_at → Last Synced (application timezone)

The downloaded file is named veracore-products-YYYY-MM-DD-HH-MM-SS.<format>.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition