Árvore de páginas

API do PDVSync.Core.Comercial responsável por obter as Pre vendas geradas no PDV Omni

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

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

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

ParametroDescriçãoTipoObservação
listIdProprietario*Lista de Proprietário para filtroLista de objetosOpcional

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": true,
    "message": "string",
    "data": [
        {
            "tipo": 0,
            "status": 0,
            "conteudo": "string",
            "numero": "string",
            "numeroVenda": "string",
            "serieVenda": "string",
            "numeroAutorizacao": "string",
            "data": "datetime",
            "observacao": "string",
            "id": "string",
            "idInquilino": "string",
            "idRetaguarda": "string",
            "dataAtualizacao": "datetime",
            "dataCadastro": "datetime",
            "idProprietario": "string",
            "loteOrigem": "string",
            "lote": "string"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Campo

Tipo

Descrição

successBooleanoIndica se a criação do compartilhamento foi feita com sucesso
messageStringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
dataLista de ObjetosLista com as prevendas
data.tipoInteiroTipo pré venda
data.statusInteiroStatus pré venda
data.conteudoStringConteúdo da pre venda em base64
data.numeroStringNúmero da pré venda
data.numeroVendaStringNúmero da venda
data.serieVendaStringSérie da venda
data.numeroAutorizacaoStringNúmero de autorização
data.dataData/HoraData da pré venda
data.observacaoStringObservação da pré venda
data.idStringIdentificador da pré venda no POSH
data.idInquilinoStringIdentificador do inquilino
data.idRetaguardaStringIdentificador da pré venda na retaguarda
data.dataAtualizacaoData/HoraUltima atualização da pré venda
data.dataCadastroData/HoraData de cadastro da pré venda
data.idProprietarioStringIdentificador do proprietário
data.loteOrigemStringIdentificador do lote Origem
data.loteStringIdentificador do lote
errorsNuloListas com os erros encontrados no processo
totalTimeInteiroTempo da requisição
numberOfRecordsInteiroNúmero de  linhas afetadas

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos



  • Sem rótulos