...
- Endpoint: /api/pdvsyncclient/v2/vendaMensagens/{idInquilino}/{qtdRegistros}
- Método: GET
- Autenticação: Bearer token
- Permissão: Client
Para esse endpoint, alguns parâmetro precisam podem ser enviados na requisição. Estes parâmetros são:
Parametro | Descrição | Tipo | Observação |
---|
idInquilino | Id inquilino do loja lote | string | Obrigatório |
qtdRegistros | Quantidade de registros pra retornar na consulta | int | Obrigatório |
chaveNfe * | Chave NFe | string | Opcional |
serie * | Série da Nota Fiscal | string | Opcional |
ccf * | CCF | string | Opcional |
dataAtualizacao * | Data de Atualização | DateTime | Opcional |
situacaoVenda * | Situação da Venda | int | Opcional |
loja * | Número da Loja | string | Opcional |
observacao * | Observação | string | Opcional |
listIdProprietario* | Lista de Proprietário para filtro | Lista de objetos | Opcional |
Obs.: Os campos em * devem ser enviados no Header do GET.
Os parâmetros opcionais funcionam como um filtro de dados, caso estejam preenchidos ele trará somente os dados relacionados ao filtro.
Expandir |
---|
title | Definição dos campos de retorno |
---|
|
| Retorno da requisição boolstring", "data": [ { "ccf": "string", "chaveAcesso": "string", "conteudo": "string", "cupom": "string", "dataEmissao": " |
| 2024-03-15T19:29:39.497ZdateTime", "numeroLoja": "string", "observacao": "string", "pdv": "string", "serieNota": "string", "status": 0, "tipo": 0, "valorBruto": " |
| stringDecimal", "situacaoVenda": 0, "id": "string", "idInquilino": "string", "idRetaguarda": "string", "dataAtualizacao": " |
| 2024-03-15T19:29:39.497ZdateTime", "dataCadastro": " |
| 2024-03-15T19:29:39.497ZdateTime", "idProprietario": "string", "loteOrigem": "string", "lote": "string" |
| } ], "errors": { "additionalProp1": "string"additionalProp2 "string"additionalProp3": "string" }, "totalTime": 0, "numberOfRecords": 0 } |
|
| Definição dos campos de retornoDefinições do retorno 200 |
| |
| Successbool requisição criação do compartilhamento foi feita com sucesso |
|
| Message | string | Mensagem de erro retornada |
Data | objeto | Objeto de retorno |
Data.Ccf | string | CCF |
Data.ChaveAcesso | string | Chave de Acesso |
Data.Conteudo | string | Conteúdo (base64) |
Data.Cupom | string | Cupom |
Data.DataEmissao | DateTime | Data de Emissão |
Data.NumeroLoja | string | Número da Loja |
Data.Observacao | string | Observação |
Data.Pdv | string | Id do PDV |
Data.SerieNota | string | Série da Nota Fiscal |
Data.Status | int | Status |
Data.Tipo | int | Tipo da Venda |
Data.ValorBruto | string | Valor Bruto |
Data.SituacaoVenda | int | Situação da Venda |
Data.Id | string | Id |
Data.IdInquilino | string | Id do Inquilino |
Data.IdRetaguarda | string | Id Retaguarda |
Data.DataAtualizacao | DateTime | Data de Atualização |
Data.DataCadastro | DateTime | Data de Cadastro |
Data.IdProprietario | string | Id do Proprietário |
Data.LoteOrigem | string | Lote Origem |
Data.Lote | string | String | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | data | Lista de Objetos | Lista com a vendas retornadas | data.ccf | String | CCF da venda | data.chaveAcesso | String | Chave de acesso | data.conteudo | String | Conteúdo da venda em base64 | data.cupom | String | Cupom da venda | data.dataEmissao | Data/Hora | Data de emissão | data.numeroLoja | String | Número da loja | data.observacao | String | Observação | data.pdv | String | PDV onde foi feita a venda | data.serieNota | String | Serie nota | data.status | Inteiro | Status da venda | data.tipo | Inteiro | Tipo da venda | data.valorBruto | Decimal | Valor bruto da venda | data.situacaoVenda | Inteiro | Situação da venda | data.id | String | Identificador da venda no POSH | data.idInquilino | String | Identificador do inquilino | data.idRetaguarda | String | Identificador da venda na retaguarda | data.dataAtualizacao | Data/Hora | Ultima data de atualização da venda | data.dataCadastro | Data/Hora | Data em que a venda foi cadastrada no PDV | data.idProprietario | String | Identificador do proprietário | data.loteOrigem | String | Identificador do lote | data.lote | String | Identificador do lote | errors | Nulo | Listas com os erros encontrados no processo | totalTime | Inteiro | tempo da requisição | numberOfRecords | Inteiro | Linha afetadas |
|
|
Expandir |
---|
|
Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
Lote