Errors
Status codes, the problem format and what to do with each error.
Errors use RFC 9457 problem details, with the
application/problem+json content type:
{
"type": "https://docs.endvr.io/docs/api/errors#validation-failed",
"title": "Validation failed",
"status": 422,
"requestId": "req_7trb2hnc8kq2",
"errors": [
{ "path": "redemptions[0].orderAmount", "message": "must be a decimal string such as \"129.90\"" }
]
}type is stable: branch on it, not on title or detail, which can change. Quote requestId when you contact
ENDVR.
Batch writes that are well formed answer 200 even if some items were rejected: check each item result (see
Report redemptions).
Error types
unauthorized
401. The key is missing, unknown or revoked. Check the Authorization header and the key in the Brand Portal.
Don't retry.
forbidden
403. The key is valid but can't do this, for example because the brand paused the connection. Don't retry.
not-found
404. The Pro Deal, product or other resource doesn't exist for this brand. Don't retry.
conflict
409. The resource is not in a state that allows the call, for example uploading codes to a Pro Deal that generates
its own, or sending a test webhook before setting an endpoint. Fix the state first.
validation-failed
422. The request is malformed. errors lists each invalid field. Fix the request; don't retry it unchanged.
rate-limited
429. Too many requests. Wait for the Retry-After seconds, then retry. See Rate limits.
internal-error
500, 502, 503 or 504. Something failed on ENDVR's side. Retry with exponential backoff; writes are safe to
retry.