Skip to Content
Developers

Report redemptions

Tell ENDVR about every order that used a Pro Deal code.

A redemption is an order in your store that used a Pro Deal code. Report each one, and report it again whenever the order changes.

What to send

{
  "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",
  "refunds": []
}
FieldWhat to put
codeThe Pro Deal code applied to the order, as the associate typed it.
orderIdYour order id. Together with code, it identifies the redemption.
orderAmountThe sum of the order's line items after discounts, without tax or shipping, as a decimal string.
currencyThe order's currency, ISO 4217.
processedAtWhen the order was placed.
statuspaid, cancelled or voided.
updatedAtWhen the order last changed in your store.
refundsOptional. Refunds are stored for reference and never billed.

Which amount is billed

The first orderAmount ENDVR receives for an order is the one billed, according to your ENDVR plan. Later updates change the status and refunds you see, not the billed amount. Refunds and cancellations are not credited.

When to send

  • When the order is placed, as soon as you can: the associate's next code opens only once this one is reported.
  • When the order changes (paid, cancelled, voided, refunded), with a newer updatedAt.
  • In a daily catch-up job that re-sends the last few days. Re-sending is safe.

Retries are safe

A redemption is unique on (code, orderId):

  • a new pair is stored: accepted;
  • the same pair with a newer updatedAt updates it: accepted;
  • the same pair with the same or an older updatedAt changes nothing: duplicate.

So you can retry a failed call, or re-send a whole day, without double counting. You don't need an idempotency key.

Batches and results

Send up to 100 redemptions per call. The answer has one result per item, in order:

{
  "results": [
    { "index": 0, "result": "accepted" },
    { "index": 1, "result": "duplicate" },
    { "index": 2, "result": "rejected", "reason": "unknown_code" }
  ]
}

A 200 doesn't mean every item was stored: check each result. A rejected item is not stored; fix it and send it again. A 422 means the request itself is malformed and nothing was stored.

reasonMeaningWhat to do
unknown_codeThe code doesn't belong to any of the brand's Pro Deals.Check it was a Pro Deal code; skip it if not.
code_not_assignedThe code was never claimed by an associate.Check the code; it may have been shared outside ENDVR.
invalid_amountorderAmount isn't a positive decimal in the order's currency.Fix the amount.

Check what ENDVR stored

curl "https://api.endvr.io/v1/redemptions?updatedSince=2026-11-17T00:00:00Z" \
  -H "Authorization: Bearer $ENDVR_API_KEY"

Filter by proDealId, code or orderId to reconcile one order.

On this page