Comece por aqui
Erros
Códigos
Cada página de endpoint lista os erros daquele endpoint, com o corpo exato. O significado geral de cada código na coleção é este.
| Código | Quando acontece |
|---|---|
| 400 | Corpo que não é JSON válido, identificador de rota inválido, ou recurso que não existe ou não pertence à loja do token. |
| 401 | Token ausente, malformado ou expirado. Autentique de novo e repita a chamada. |
| 403 | A filial informada na rota não está vinculada à matriz do token. |
| 404 | O recurso consultado não foi encontrado. |
| 422 | A requisição foi entendida e recusada por regra: campo obrigatório ausente, lote vazio ou acima do teto, estado que não permite a operação. |
Dois formatos de corpo
Na maior parte dos endpoints o erro vem em um objeto com o campo error. A coleção registra uma exceção nas rotas de estoque em lote, que respondem com code, message e errorDescription. Trate os dois formatos.
{"error":"authorization header is invalid"}200 não significa que tudo entrou
Operações em lote respondem 200 mesmo quando parte dos itens é recusada: a resposta separa o que foi aceito do que não foi. É o caso do estoque em lote e da inclusão de clientes e de produtos em contrato. Leia o corpo da resposta e reprocesse só o que foi recusado.
400 que não é erro seu
Na listagem de saldo de cashback por cliente, 400 com no record found significa que a loja não tem registro ou que o offset passou do fim da lista. A coleção trata isso como fim de paginação, não como requisição inválida.
Endpoints relacionados
Comece por aqui
- Ambientes e URL base: A URL base, a variável url da coleção e quem chama quem.
- Autenticação: Um token por 12 horas, enviado como Bearer em todas as chamadas.
- Paginação e limites: limit e offset, tetos por endpoint e as duas rotas de lote.
Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.