Export blacklist rules
The rules the same filters would list, as a CSV file, newest first: each one’s type, value and note, whether it is in force, when and how it was added, the customer or order it came from, and how many checkouts it has stopped. Every rule the filters match is in the file. 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 fraud.read permission (Read Fraud Protection). 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
Only rules that are in force, or only ones switched off.
enabled, disabled Only rules of this type.
email, domain, ip, cidr, asn, isp, city Part of a rule's value or note.
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 Response
The file itself, not a JSON envelope.
The response is of type file.

