GET – PEDIDO DE VENDA
Através da consulta de pedido do venda pode ser acompanhado o histórico de eventos do pedido de venda e informações como a situação do pedido de venda, o código de rastreio e o número do documento fiscal.
Para o consumo da chamada, você deve utilizar o seguinte endereço:
Parâmetros a serem passados na chamada:
Authorization:
- Deverá ser passado o Bearer Token de autenticação.
id:
- Deverá ser passado o identificador único do pedido de venda.
Parâmetros retornados na chamada:
cancelado:
- A situação do pedido de venda no Hiper.
- Tipo do campo: boolean.
- Se for true, o pedido de venda está cancelado.
- Se for false, o pedido de venda está ativo.
chaveDocumentoFiscal:
- A chave completa da nota fiscal eletrônica (NF-e).
- Tipo do campo: string com 44 caracteres.
codigoDaSituacaoDeProcessamento:
- A situação do processamento do pedido de venda no Hiper.
- Em processamento: 1 // Processado com sucesso: 2 // Processado com erro: 3.
- Tipo do campo: inteiro com até 2 caracteres.
codigoDoPedidoDeVenda:
- O número do pedido de venda no Hiper.
- Tipo do campo: string com até 40 caracteres.
data:
- A data de criação do pedido de venda no Hiper.
- Tipo do campo: data com o formato dd/MM/yyyy.
eventos // chaveDocumentoFiscal:
eventos // codigoDoTipoDeEvento:
- O código do tipo de evento do pedido de venda no Hiper.
- Processamento do pedido: 1 // Separação do produto em estoque: 2 // Emissão da nota fiscal: 3 // Entrega à transportadora: 4 // Cancelamento: 99.
- Tipo do campo: interno com até 2 caracteres.
eventos // data:
- A data que foi realizado o evento.
- Tipo do campo: data com o formato dd/MM/yyyy.
eventos // observacao:
- A observação do evento.
- Tipo do campo: string.
- A observação do evento pode retornar os detalhes de cada evento realizado no pedido de venda. Com a observação, será possível saber qual o número do documento fiscal, o código de rastreio da transportadora e qual o erro que ocorreu durante o processamento do pedido de venda.
eventos // tipoDocumentoFiscal:
- O tipo de documento que foi realizado o faturamento do pedido de venda
- Exemplos: NF, NF-e ou NFVC.
- Tipo do campo: string
eventos // urlArquivoXml:
- A URL com o link para download do arquivo XML da nota fiscal eletrônica (NF-e).
- Tipo do campo: string
pedidoDeVendaId:
- O identificador único do pedido de venda cadastrado no Hiper.
- Tipo do campo: uniqueidentifier com 36 caracteres.
Exemplo de resposta:
{
“cancelado”: true,
“codigoDaSituacaoDeProcessamento”: 2,
“codigoDoPedidoDeVenda”: null,
“data”: “27/03/2020 17:13:05”,
“eventos”: [
{
“chaveDocumentoFiscal”: “42201212605982000124552880000025701319587551”,
“codigoDoTipoDeEvento”: 3,
“data”: “17/12/2020 13:20:48”,
“observacao”: “Número da Nota Fiscal: 2570 – Série: 288”,
“tipoDocumentoFiscal”: “NFE”,
“urlArquivoXml”: “https://hiper-gestao.s3.amazonaws.com/30becddf-be6c-4c52-9492-587da40235e4/Xmls/2020_12/12605982000124/Emitidos/Saidas/Nfe/Autorizadas/42201212605982000124552880000025701319587551-Nfe.xml”
}
],
“pedidoDeVendaId”: “43a42deb-789f-4f67-a329-8172c1b0f611”,
“errors”: [ ],
“message”: null
}