Skip to main content

Export Suppliers

GET 
/api/v2/suppliers/export

Export the supplier list as a spreadsheet file. Synchronous — the response body is the file itself (text/csv or, with format=xlsx, an Excel workbook) named suppliers-{timestamp}.{format}.

Required scope: suppliers:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Accepts the same filters as the supplier list, so you can export a filtered subset. Every matching supplier is included (no pagination), ordered by ID ascending, with a fixed column set: ID, Name, Company Name, Email, Contact Name, Lead Time, Min Order Qty, Created At, Updated At, PO Email, Website, Minimum PO $, Minimum PO Qty, Fax, address fields (lines 1-3, city, state/province and code, zip, country and code, label), Default Pricing Tier ID, Default Warehouse ID, and Default Store ID.

By default only non-archived suppliers are exported; use filter[archived]=all or filter[archived]=only to change that.

Requires the suppliers:read token scope.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition