Histórico da Página
...
| Linha de Produto: | TOTVS Varejo Lojas |
|---|---|
| Segmento: | Varejo |
| Módulo: | SigaLoja (Controle de Loja) |
| Função: | RmiEnvPdvSyncObj |
| Ticket: | Não há. |
| Story: | DVARLOJ1- 79278248 |
02. SITUAÇÃO/REQUISITO
Disponibilizar alguma maneira de consultar as notas fiscais de saída, onde seja possível visualizar os itens que já foram devolvidos
...
Foi disponibilizada API no seguinte caminho: ...endereço do serviço RESThttp://{urlRest}/api/retail/v1/notasaida/lista
A API utiliza o método POST, caso queria informar parâmetros para filtro os mesmos devem ser passados no corpo.
Exemplo:
{
"dataInicio": "2019010120220101",
"dataFim": "20190130"
}
...
"20220914",
"cupom": "39",
"pagina": 1
}
Parâmetros de entrada (Request):
| Parâmetro | Tipo | Obrigatório | Objetivo |
| dataInicio | Data | SIM, quando não informado o cupom | Filtrar data da venda |
| dataFim | Data | SIM, quando não informado o cupom | Filtrar data da venda |
| cpfCnpj | String | N | Pesquisar com base no CPF informado no Cupom ou com base no código do cliente identificado na venda que possui o CPF informado na pesquisa |
| serie | String | N | Serie documento fiscal, algo interno do Protheus(F2_SERIE), exemplo: SAT não possui série de documento, possui serial apenas de equipamento. |
| cupom | String | N | Número do documento fiscal (não precisa informar a série, se informar apenas o cupom, deverá retornar todos os cupons com o mesmo número, não importa a série). Não devemos obrigar informar zeros a esquerda se o Protheus gravar com zeros, devemos abstrair essa regra. |
| IdRetaguardaProduto | String | N | Id do Produto (mesmo formato que enviamos o produto na integração) |
| IdRetaguardaLoja | String | N | Id da Loja que emitiu o cupom, será utilizado para pesquisar o documento da SF2 (esse campo será utilizado para identificar o cupom quando for gerar o Crédito/Nota de Entrada) |
| tipo | Array String | N | Permitir filtrar somente alguns tipos de cupons, exemplo: O PDV OMNISHOP não emite NF-e, ou seja, se passar no filtro que deseja somente NFC-e e SAT, não iremos devolver vendas NF-e gravadas no ERP. |
| pagina | Int | N | Quando possuir paginação, informar a página. |
| itensPagina | Int | N | Quantidade de itens que serão retornados por página. |
Retorno:
{
"data": [
{
"idRetaguardaLoja": "D PR 02 ",
"descricaodataHora": " 2022031116:56",
"idRetaguardaLojacpfCnpj": "D MG 01 26664794000181",
"dataHoravalorTotal": "2019011109:27"503,
"tipo": "SATCE",
"qtdItens": 3,
"itens": [
{
"descricao": "PROD1 LOJA - 10% - ICMS - TEN ",
"valorUnitario": 300,
"qtdVendida": 1,
"qtdDisponivel": 1,
"idRetaguardaCupomItem": "D PR 02 000039 0 01",
"idRetaguardaProduto": "LJTEST01 "
},
{
"descricao": "D MG 01 15 LOJ01",
"situacao"PROD2 LOJA - 12% - ICMS ",
"valorUnitario": 200,
"qtdVendida": 1,
"disponível qtdDisponivel": 1,
"cpdCnpjidRetaguardaCupomItem": "26865525140 D PR 02 000039 0 02",
"valorTotalidRetaguardaProduto": 10,
"tipo"LJTEST02 "
},
{
"descricao": "CF PROD3 LOJA - 17% - ICMS - ALT ",
"valorUnitario": 103,
"qtdVendida": 1,
"qtdItensqtdDisponivel": 1,
"serie "idRetaguardaCupomItem": "D PR 02 000039 0 03",
"idRetaguardaProduto": "LOJ"LJTEST03 "
}
],
"qtdDisponivelserie": 1"0 ",
"idRetaguardaCupom": "D MG 01 15 LOJD PR 02 000039 0 ",
"cupom": "15 000039 ",
"idRetaguardaProdutosituacao": "LOTE DISPONÍVEL "
}
],
"messagesuccess": ""true,
"successhasNext": truefalse,
"hasNextmessage": ""
}
| Nota |
|---|
Para o controle de paginação, utilize a tag "hasNext", caso o seu retorno seja true |
...
, significa que existe mais registros para serem retornados a partir do filtro informado. Incremente a tag "pagina", para solicitar os demais registros. |
04. DEMAIS INFORMAÇÕES
Envia Condição de PagamentoNão há
05. ASSUNTOS RELACIONADOS
- Guia da Integração Smart Hub Protheus
- Configurando os serviços do Smart Hub Protheus
- Dúvidas Frequentes - Varejo
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas