Docs
API

Erros

Formato dos erros (problem+json) e os códigos mais comuns.

Erros vêm com o status HTTP certo e corpo no formato RFC 9457 (application/problem+json). Use o campo code: ele não muda. O title é texto para gente e pode mudar.

{
  "type": "https://docs.rivoo.gg/api/erros#validation_failed",
  "title": "Dados inválidos",
  "status": 422,
  "code": "validation_failed",
  "errors": [{ "field": "items.0.quantity", "code": "min", "message": "quantity must not be less than 1" }],
  "requestId": "req_mhexample0000request0001"
}

Mande o requestId ao suporte quando precisar de ajuda com uma chamada.

Códigos comuns

StatuscodeQuando
400bad_requestJSON malformado ou parâmetro inválido.
401unauthenticated / invalid_api_keySem chave, ou chave inválida. Veja Autenticação.
403permission_deniedA chave não pode fazer isso.
404route_not_foundCaminho ou método que não existe.
404*_not_foundO recurso não existe nesta loja (ex.: order_not_found).
409idempotency_in_progressA mesma Idempotency-Key ainda está sendo processada. Tente de novo em instantes.
413payload_too_largeCorpo acima de 1 MB.
422validation_failedCampos inválidos: veja errors[], um item por campo.
422idempotency_key_reusedA mesma Idempotency-Key com outro corpo. Veja Idempotência.
429rate_limitedPassou do limite. Espere o Retry-After. Veja Limites.
500internal_errorFalha nossa. Tente de novo com a mesma Idempotency-Key.

Cada operação da referência lista, em Respostas, os códigos que pode devolver, com um exemplo de corpo por código. Os de Criar pedido estão explicados em Pedidos.

Nesta página