Skip to main content

Download PO CSV Sample

POST 
/api/suppliers/:supplier/csv-sample

Legacy proxy. Generate and download a 3-row sample CSV showing exactly which columns will be included in this supplier's outgoing PO email attachment.

This endpoint is kept for backward compatibility — new clients should call POST /api/suppliers/:supplier/po-sample instead, which supports both CSV and XLSX (format=xlsx). Internally this route forwards to po-sample with format=csv forced.

Used by the per-supplier CSV column picker so users can preview the layout before saving.

Request body (all optional):

  • columns (array of strings) — Unsaved column selection to preview. If omitted, the saved supplier preference is used; if that is also empty, the tenant default falls through, then the system default (every registered column).

Valid column keys (current registry): purchase_order, sku, barcode, supplier_sku, name, qty_ordered, unit_cost, extended_cost. Unknown keys are silently dropped.

The response is a CSV file download (Content-Type: text/csv), not JSON.

Authentication: Requires Bearer token. Scope: suppliers:rw.

Request​

Responses​

Successful response