...
Os parâmetros para a requisição estão abaixo
Campo | Tipo | Descrição | Tipo Parâmetro | Obrigatório | Observação |
---|
IdInquilino | string | Identificador do Inquilino | Parameter/Path/Query Params | Sim | Usado apenas pelo PDV. Retaguarda não precisa criar API com esse parâmetro |
IdRetaguardaLoja | string | Identificador da loja na retaguarda | Parameter/Path/Query Params | Sim |
|
cpfCnpj | string | Documento do cliente | Header | Não |
|
idRetaguardaCredito | string | Código do crédito disponível do cliente | Header | Não |
|
Retornos
Deck of Cards |
---|
|
Card |
---|
| Campo | Tipo | Descrição |
---|
Success | bool | Indica se a requisição foi feita com sucesso | Message | string | Mensagem de retorno de erros | Creditos | Lista de Objetos | Lista com os créditos retornados | Creditos.saldo | double | Saldo do crédito | Credito.IdRetaguardaCredito | string | Identificador do crédito na retaguarda |
Card |
---|
| { "success": true, "message": "string", "creditos": [ { "saldo": 0.0, "idRetaguardaCredito": "string" } ] } |
|
Card |
---|
| Campo | Tipo | Descrição | Observação |
---|
Success | bool | Indica se a requisição foi feita com sucesso |
| Message | string | Mensagem de retorno de erros |
| Creditos | Objeto | Objeto de retorno |
|
{ "success": false, "message": "string", "creditos": null } |
|