Quickstart
Check your key, read a Pro Deal and report a test redemption.
You need a test key (endvr_ik_test_…), created by an Owner or Admin in the Brand Portal under
Brand Settings › Integrations. Test keys write test data that is never billed, so you can try everything safely.
export ENDVR_API_KEY="endvr_ik_test_..."Check the key
curl https://api.endvr.io/v1/connection \
-H "Authorization: Bearer $ENDVR_API_KEY"{
"brandId": "64b7f0c2a1d2e3f4a5b6c7d8",
"brandName": "Acme Outdoor",
"platform": "woocommerce",
"mode": "test",
"status": "waiting_first_event",
"lastEventAt": null
}Find a Pro Deal and its codes
curl "https://api.endvr.io/v1/pro-deals?status=scheduled" \
-H "Authorization: Bearer $ENDVR_API_KEY"
curl "https://api.endvr.io/v1/pro-deals/6730f1c2a9d4e5b6c7d8e9f0/codes?limit=100" \
-H "Authorization: Bearer $ENDVR_API_KEY"Create each code in your store as a single-use discount code with the Pro Deal's discount.
Confirm the codes are live
curl -X POST https://api.endvr.io/v1/pro-deals/6730f1c2a9d4e5b6c7d8e9f0/codes/confirm \
-H "Authorization: Bearer $ENDVR_API_KEY"ENDVR releases the Pro Deal to associates; the answer is the Pro Deal with codesReady: true.
Report a redemption
curl -X POST https://api.endvr.io/v1/redemptions \
-H "Authorization: Bearer $ENDVR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"redemptions": [{
"code": "PRO-7KQ2-XM4D",
"orderId": "10042",
"orderAmount": "129.90",
"currency": "USD",
"processedAt": "2026-11-17T14:03:00Z",
"status": "paid",
"updatedAt": "2026-11-17T14:03:00Z"
}]
}'{ "results": [{ "index": 0, "result": "accepted" }] }Next steps
- Follow Integrate Pro Deals for the complete flow and the jobs to run.
- Set up webhooks so codes stop working when they must.