Skip to main content

Export Suppliers

GET 
/api/v2/suppliers/export

Export suppliers to a spreadsheet. The file contains one column per supplier field — the same field set the supplier spreadsheet import accepts, with matching headings, so an exported file can be edited and re-imported without remapping columns.

Required scope: suppliers:read

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

Authentication: requires a Bearer token with the suppliers:read scope.

Columns (in file order, 78 plus one per custom field): 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 Line 1, Address Line 2, Address Line 3, City, State/Province, State/Province Code, Zip/Postal Code, Country, Country Code, Address Label, Default Pricing Tier ID, Default Tax Rate, Default Pricing Tier, Default Warehouse ID, Default Store ID, Type, Messaging Phone, Timezone, Archived At, Address Contact Name, Address Company, Address Phone, Target Stock Days, Default Warehouse, Default Store, Default Payment Term, Default Payment Term ID, Default Tax Rate ID, Default Incoterm, Default Incoterm ID, Default Incoterm Place, Default Shipping Method, Default Shipping Method ID, PO Submission Format, PO CSV Columns (JSON), PO Processing Method, PO Batch Schedule (JSON), Backorder PO Schedule (JSON), Auto Submit Dropship PO, Auto Fulfill Dropship, Auto Generate Backorder PO, Auto Submit Backorder PO, Auto Split Backorder PO By Brand, Auto Receive Backorder PO, Schedule Last Run (JSON), Default Stock Level, Stock Mode, In Stock Quantity, Stock Buffer %, Default Deposit %, Auto Apply Deposits, Payment Instructions, Payment Instructions Verified At, Payment Instructions Verified By, Invoice Reminders Mode, Invoice Reminder Interval (days), Invoice Reminder Max Count, Invoice Reminder Start After (days), Manufacturing Contractor, Contractor Default Warehouse, Contractor Default Warehouse ID, Outsourced Cost Basis, Contacts, Products.

The four timestamp columns above (Created At, Updated At, Archived At, Payment Instructions Verified At) carry the account timezone in the heading — Created At (America/New_York), or Created At (UTC) for an account on UTC. The suffix is the IANA identifier, not an abbreviation, because an export spanning a DST boundary holds rows on both sides of the change. All four are export-only, so import column auto-mapping is unaffected.

Each active supplier custom field appends a Custom: <field name> column.

Export-only columns — present in the file but ignored on import, because they are derived values, audit stamps, or the raw foreign key whose by-name twin is importable: Created At, Updated At, Archived At, Default Pricing Tier ID, Default Warehouse ID, Default Store ID, Default Payment Term ID, Default Tax Rate ID, Default Incoterm ID, Default Shipping Method ID, Contractor Default Warehouse ID, Schedule Last Run (JSON), Payment Instructions Verified At, Payment Instructions Verified By, Contacts, Products. Every other column round-trips.

Cell formats

  • Yes/No columns (Auto …, Manufacturing Contractor, Auto Apply Deposits) export as Yes / No.
  • Enum columns (Type, Stock Mode, Default Stock Level, PO Submission Format, PO Processing Method, Invoice Reminders Mode, Outsourced Cost Basis) export their stored value, e.g. goods, buffered.
  • (JSON) columns export compact JSON, e.g. [{"time":"09:00","days":["monday"]}]. An empty array exports as blank.
  • Timestamp columns export as YYYY-MM-DD HH:MM:SS already converted from UTC to the account's timezone, so they match what the app displays. The cell carries no offset — spreadsheets reject one — so the timezone is named in the heading instead.
  • Lookup columns (Default Warehouse, Default Store, Default Payment Term, Default Tax Rate, Default Pricing Tier, Default Incoterm, Default Shipping Method, Contractor Default Warehouse) export the referenced record's name/code and resolve by that name/code on import.
  • Redacted address values export as blank rather than leaking the redaction placeholder.

Which suppliers are exported — scope:

  • filtered (default) — every supplier matching the filter[...] / filter_groups parameters on this request.
  • all — every supplier, ignoring all filters on the request.
  • current_page — only the current page, honouring page / per_page.
  • selected — only the ids listed in ids (comma-separated).

Contacts — pass include_contacts=true (or content_mode=contacts) to append the supplier's contacts. The file then has one row per contact with the supplier columns repeated, followed by: Contact ID, Contact Name, Contact Email, Contact Phone, Contact Role, Contact Title, Contact Primary, Contact Notes. Primary contact first, then oldest first.

Filtering, searching and sorting use exactly the same parameters as the supplier list endpoint — see "List Suppliers" for the full field and operator reference.

The response is a file download named suppliers-YYYY-MM-DD-HH-MM-SS.<format>.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition