Skip to main content
A API utiliza códigos de status HTTP padrão para indicar o sucesso ou a falha de uma requisição.

Códigos de status HTTP

A maioria das respostas de erro inclui um campo error com uma mensagem descritiva do problema. A exceção é o 400 de coerção de parâmetros (ver abaixo), que usa errors (array).

400 — corpo ou parâmetros inválidos

Quando um campo não corresponde ao tipo/formato esperado pela API (ex.: end-date não é uma data, extension-plan-rule traz itens sem product-id/end-date ou repete um mesmo product-id), a resposta traz errors — um array, não o campo error singular — com um item por campo problemático:

401 — autenticação

403 — autorização

Além dos casos específicos de cada endpoint, requisições fora do escopo autorizado do token recebem: Você não tem permissão para acessar este recurso. Para movimentações (inclusão/exclusão), respostas 422 trazem um catálogo detalhado de validações — veja Ofensas.