Através deste endoint é possível consultar a lista de NSNRecs vinculados a um BP-e a partir de sua chave de acesso.
URL
Produção: POST https://bpe.ns.eti.br/v1/util/listar/nsnrecs
Dados de entrada
Os dados de entrada deste método por ser enviado no corpo da requisição em formato JSON ou como QueryString na URL do método.
| Campo | Descrição | Tipo | Ocorrência | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | A | 1-1 | |
| chBPe | Chave de acesso do BP-e | N | 1-1 | |
| tpAmb | Tipo do ambiente de autorização do CT-e 1 - Produção; 2 - Homologação | N | 0-1 | Valor padrão: 1 |
Requisição de Lista de NSNRecs
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"chBPe": "43211207364617000135630060000027251476663295",
"tpAmb": "2"
}'\
https://mdfe.ns.eti.br/util/list/nsnrecs
Dados retornados
| Campo | Descrição | Tipo | Ocorrência | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | N | 1-1 | ||
| motivo | Descrição literal do status de processamento | A | 1-1 | ||
| nsNRecs | Objeto contendo os dados da pessoa solicitada | Array | 1-1 | Conterá itens apenas se forem encontrados nsNRecs vinculados a chave do BP-e fornecido | |
| nsNRecs | nsNRec vinculado | N | 1-1 | nsNRecs | |
| cStat | Código do status do nsNRec | N | 1-1 | nsNRecs | |
| xMotivo | Descrição literal do status do nsNRec | A | 1-1 | nsNRecs |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"nsNRecs": [
{
"nsNRec": 210584,
"cStat": 100,
"xMotivo": "Autorizado o uso do BP-e"
}
]
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |
| -2 | Chave de acesso inválida |