Export customers
The customers the same filters would list, as a CSV file: each one’s email, when they were first seen, the orders they paid for and what they spent, their first and last paid order, their store balance, their affiliate code and balance where they have one, their tags, and whether they are subscribed to the store’s news and offers. Every customer the filters match is in the file, however many: it is sent as it is read. Add check=1 for { rows }, how many it would have, which is not counted. A store exports at most 30 files every 10 minutes, orders, customers, fraud events and blacklist rules together, whoever asks: after that the answer is 429.
Needs the customers.read permission (Read Customers). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key.
Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.
Query Parameters
Part of an email address.
What the file is ordered by, largest or latest first.
newest, spent, orders, recent, balance Only customers who are affiliates, or who are subscribed to the store's news and offers.
affiliates, subscribed Only customers wearing this tag: vip, disputed, or the ID of one of the store's own.
1 for how many rows the file would have, as { rows }, in place of the file. Not counted against the store's exports, and refused with 429 where none are left.
1 Only customers first seen in this period.
today, yesterday, 7d, 30d, this_week, last_week, this_month, last_month, this_year Only customers first seen on or after this day, as YYYY-MM-DD. With to, in place of range.
Only customers first seen on or before this day, as YYYY-MM-DD.
The time zone those days are in, as an IANA name. Left out, UTC.
"Europe/Berlin"
Response
The file itself, not a JSON envelope.
The response is of type file.

