v1
latestOpenAPI 3.1.02026-08-0441813.4 KBMerchants
Batch merchant offer codes
Retrieve ranked offer codes for a set of merchants. Up to 20 queries per request. Each result contains an items array of codes; misses return an empty items array. Add an idempotency_key to deduplicate requests; we suggest using sha256(user_email + date) or similar.
post/v1/merchants/codes
Request body
Example request
{
"queries": [
{
"query_id": "q1",
"merchant_id": "01hz4vdrcnxhfmfcvy3rfqk1fp",
"idempotency_key": "a3f1e2d4b5c6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2"
}
]
}Response
Per-query results. Each result has an items array of codes. Misses return an empty items array.
Example response
{
"results": [
{
"query_id": "q1",
"items": [
{
"code": "SAVE10",
"probability": 0.92,
"value_type": "percent",
"value_amount": 10,
"currency": "USD",
"conditions": [
"minimum_subtotal"
],
"redirect_url": "https://go.checkmate.com/r/acme?code=SAVE10&ref=ck_partner_api",
"last_success": "2026-06-16T17:00:00.000Z",
"description": "10% off your first order",
"apply_count": 1280,
"success_count": 940
}
]
}
]
}