Árvore de páginas

API do PDVSync.Core.Comercial responsável por obter as Vendas para a atualização de Status da Venda no PDV Omnishop.

Para acessar os dados a requisição é a seguinte

  • Endpoint: /api/pdvsyncclient/v2/vendaMensagens/{idInquilino}/{qtdRegistros}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Client

Para esse endpoint, alguns parâmetro precisam ser enviados na requisição. Estes parâmetros são:

ParametroDescriçãoTipoObservação
idInquilinoId inquilino do loja lotestringObrigatório
qtdRegistrosQuantidade de registros pra retornar na consultaintObrigatório
chaveNfe *Chave NFestringOpcional
serie *Série da Nota FiscalstringOpcional
ccf *CCFstringOpcional
dataAtualizacao *Data de AtualizaçãoDateTimeOpcional
situacaoVenda *Situação da VendaintOpcional
loja *Número da LojastringOpcional
observacao *ObservaçãostringOpcional

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.

{
  "success": bool,
  "message": "string",
  "data": [
    {
      "ccf": "string",
      "chaveAcesso": "string",
      "conteudo": "string",
      "cupom": "string",
      "dataEmissao": "2024-03-15T19:29:39.497Z",
      "numeroLoja": "string",
      "observacao": "string",
      "pdv": "string",
      "serieNota": "string",
      "status": 0,
      "tipo": 0,
      "valorBruto": "string",
      "situacaoVenda": 0,
      "id": "string",
      "idInquilino": "string",
      "idRetaguarda": "string",
      "dataAtualizacao": "2024-03-15T19:29:39.497Z",
      "dataCadastro": "2024-03-15T19:29:39.497Z",
      "idProprietario": "string",
      "loteOrigem": "string",
      "lote": "string"
    }
  ],
  "errors": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "totalTime": 0,
  "numberOfRecords": 0
}

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucesso
Messagestring

Mensagem de erro retornada 

DataobjetoObjeto de retorno
Data.CcfstringCCF
Data.ChaveAcessostringChave de Acesso
Data.ConteudostringConteúdo (base64)
Data.CupomstringCupom
Data.DataEmissaoDateTimeData de Emissão
Data.NumeroLojastringNúmero da Loja
Data.ObservacaostringObservação
Data.PdvstringId do PDV
Data.SerieNotastringSérie da Nota Fiscal
Data.StatusintStatus
Data.TipointTipo da Venda
Data.ValorBrutostringValor Bruto
Data.SituacaoVendaintSituação da Venda
Data.IdstringId
Data.IdInquilinostringId do Inquilino
Data.IdRetaguardastringId Retaguarda
Data.DataAtualizacaoDateTimeData de Atualização
Data.DataCadastroDateTimeData de Cadastro
Data.IdProprietariostringId do Proprietário
Data.LoteOrigemstringLote Origem
Data.LotestringLote



  • Sem rótulos