Através do serviço de Consulta Situação da BP-e é possível obter a informação de qual o estado atual da BP-e no banco de dados da Sefaz.
Esta funcionalidade é muito utilizada em casos onde é necessário verificar a existência e validade de uma BP-e, assim como obter informações sobre os eventos ocorridos com a mesma (ex.: não embarque por Evento de Não Embarque).
URL
Produção: POST https://bpe.ns.eti.br/v1/bpe/status
Dados de entrada
| Campo | Descrição | Tipo | Ocorrência | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | A | 0-1 | |
| licencaCnpj | CNPJ da licença interessada em consultar a situação do BP-e | N | 0-1 | Utilizado para identificar o certificado digital que deverá ser utilizadoSe não for enviado, o CNPJ será extraído da chave enviada no campo chBPe |
| chBPe | Chave de acesso do BP-e | N | 1-1 | |
| tpAmb | Tipo do ambiente de autorização do BP-e 1 - Produção, 2 - Homologação | N | 1-1 |
Exemplo de requisição
Consulta de situação
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"licencaCnpj": "07364617000135",
"chBPe": "43161107364617000135550000000099461000094833",
"tpAmb": "2"
}'\
http://nfehml.ns.eti.br/nfe/stat
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| retConsSitBPe | Objeto contendo os dados do protocolo de autorização do BP-e e todos os eventos vinculados. | Somente em status = 200 |
| erro | Objeto contendo os dados de erro ocorrido durante o processamento | Somente em status = -6 ou -999 |
| erro.cStat | Código de status do erro | |
| erro.xMotivo | Descrição literal do erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retConsSitBPe": {
"tpAmb": "2",
"verAplic": "RS20171205154014",
"cStat": "100",
"xMotivo": "Autorizado o uso do BP-e",
"cUF": "43",
"protBPe": [
{
"infProt": {
"Id": "BPe143180000001887",
"tpAmb": "2",
"verAplic": "RS20180129113520",
"chBPe": "43180107364617000135630000000000101000000085",
"dhRecbto": "2018-01-31T16:46:20-02:00",
"nProt": "143180000001887",
"digVal": "cO+hoNR2g9RsL1dGF7RuiTf2vzU=",
"cStat": "100",
"xMotivo": "Autorizado o uso do BP-e"
},
"versao": "1.00"
}
],
"versao": "1.00"
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |
| -400 | Chave do BP-e ou Tipo do Ambiente não informados |
| -3 | Chave de acesso inválida |
| -6 | Erro ao realizar a consulta. Verifique o objeto erro para identificar o motivo. |