Skip to main content

Export Customers

GET 
/api/v2/customers/export

Download all customers matching the current filters as a spreadsheet file (CSV by default, XLSX when format=xlsx). The file contains the columns: Sr No., id, name, company, email, sales_channel_origin_name, integration_instance_name, created_at, updated_at, phone, then the default shipping address (shipping_name, shipping_company, shipping_address1, shipping_address2, shipping_address3, shipping_city, shipping_province, shipping_zip, shipping_country, shipping_phone) and the default billing address (billing_name, billing_company, billing_address1, billing_address2, billing_address3, billing_city, billing_province, billing_zip, billing_country, billing_phone). then the customer's default settings (default_warehouse, default_warehouse_id, default_pricing_tier, default_sales_rep, default_store, default_shipping_method_domestic, default_shipping_method_international — names, except the warehouse id; blank when not set). Address columns are blank when the customer has no default address of that type. Rows are ordered by customer ID ascending and the export is not paginated - every matching customer is included.

Required scope: customers:read

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

Privacy: customers originating from Amazon are redacted - the row keeps its serial number but every other column is blank.

Timestamps in the file are converted to the account's local timezone (matching on-screen values).

Filtering uses operator-style parameters: filter[column.operator]=value. A bare filter[column]=value acts as the 'is' operator.

Text columns (name, email, company, phone, city, province, country) support: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty. The city, province, and country filters match the customer's default shipping address.

Date columns (created_at, updated_at, archived_at) support: is, is_not, before, after, on_or_before, on_or_after, between (two comma-separated dates), is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days. Dates use YYYY-MM-DD format and are interpreted in the account's local timezone.

Archived customers are excluded unless filter[archived] is provided ('only' = archived customers only, 'all' = archived and active).

The response is a file download (Content-Type: text/csv or the XLSX MIME type), not JSON.

Authentication: Requires Bearer token with the customers read/write scope.

Optional. When include_contacts=1, the export flattens to one row per contact with the parent columns repeated (parent-only row when a record has no contacts), appending Contact ID/Name/Email/Phone/Role/Title/Primary/Notes columns.

When content_mode=addresses, the export flattens to one row per saved address with the customer columns repeated: the default shipping address, then the default billing address (one row labelled 'Default Shipping & Billing' when they are the same address), then every other address in the customer's address book. Appended columns: Address ID, Address Type (Default Shipping, Default Billing, Default Shipping & Billing, Additional), Address Label, Address Name, Address Company, Address Email, Address Phone, Address Line 1, Address Line 2, Address Line 3, Address City, Address Province, Address Zip, Address Country. Customers with no saved addresses keep a single row with the address columns blank.

Request​

Responses​

OK

Response Headers
    Content-Type