List cart recovery optouts
The store’s SUPPRESSION list: every address that asked this merchant to stop mailing them. It is published so you can honour the same suppressions in your own sending. It is not a mailing list, and treating it as a source of contactable people inverts its entire meaning. THERE IS NO GET BY ADDRESS because ?email= answers the same question better. “Is this address suppressed” returns an empty page when it is not, which is the correct answer; a 404 would be an error status for a perfectly normal outcome and every client would have to treat it as success. Addresses are stored lowercased and trimmed. Normalise the same way before comparing, or a mixed-case address reads as absent and mail goes to someone who asked a merchant to stop.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Query Parameters
Exact match, not a prefix search, so this list cannot be enumerated by guessing. It is how you ask whether one address is suppressed before a send: an address that is not returns an EMPTY PAGE rather than a 404, because "nobody suppressed" is a normal answer and not an error. The value is lowercased and trimmed before it is matched, so case does not matter here. A malformed address is also an empty page rather than a 400: on a filter that is a question with a correct answer.
Filter by why the address was suppressed. An unrecognised value is a 400 rather than an empty page: "no address was suppressed for that reason" and "there is no such reason" are different facts, and a client told the former concludes the complaints it forwarded never arrived.
unsubscribe, bounce, complaint, manual Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.
1 <= x <= 100The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.
