Referência da API · Limite de Crédito

Listar Limites de Crédito

Método: GET
Rota: /creditLimit/list
URL base: https://ws.autorei.net
Parâmetros de consulta do exemplo: document=29.893.264/0001-01 limit=5
Token: Exige token Bearer

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Lista os limites de crédito da sua loja, com opção de filtrar por cliente.

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`document`	string	Não	CPF ou CNPJ do cliente. Omitido, a listagem traz os limites da loja.
`limit`	integer	Não	Registros por página. Padrão 5, teto 25, valor acima disso é reduzido para 25, sem erro.
`offset`	integer	Não	Registro inicial da página. Padrão 0.

Regras de negócio

Sem registros, a resposta não é uma lista

Quando há limites, a resposta é um array. Quando não há nenhum, ela é um objeto vazio ({}). Trate os dois formatos: iterar direto sobre a resposta quebra no caso vazio.

Resposta · 200

Array com um objeto por limite de crédito.

Campo	Tipo	Descrição
`document`	string	Documento do cliente.
`credit_code`	string	Código do tipo de limite.
`credit_type`	string	Nome do tipo de limite.
`value`	number	Valor total do limite.
`balance`	number	Saldo disponível.
`active`	boolean	Se o limite está ativo.
`without_credit_limit`	boolean	Se o cliente compra sem saldo.

Erros

Código	Quando
401	Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/creditLimit/list?document=29.893.264/0001-01&limit=5' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: um limite encontrado

[
  {
    "without_credit_limit": false,
    "balance": 5000,
    "document": "29.893.264/0001-01",
    "credit_code": "CREDITO-PADRAO",
    "active": true,
    "credit_type": "Crédito Padrão",
    "value": 5000
  }
]

Usado em

Casos de usoIntegração ERP: o caminho típico pela API
Casos de usoPortal B2B próprio: o caminho típico pela API
Casos de usoMarketplace B2B: o caminho típico pela API
Casos de usoVarejo complexo e B2B2C: o caminho típico pela API
Casos de usoCompras B2B e suprimentos: o caminho típico pela API
Casos de usoVenda assistida e balcão: o caminho típico pela API
Comece por aquiPaginação e limites

Endpoints relacionados

POST Criar Tipo de Limite de Crédito /creditLimit/saveTypeCreditLimit
POST Definir ou Atualizar Limite de Crédito para Cliente /creditLimit/save

← Ver o grupo: Limite de Crédito

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.