Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

API do PDVSync.Core.Comercial responsável por obter os Caixa geradas no dados consolidados do PDV Omni na retaguarda.

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

...

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

ParametroParâmetroDescriçãoTipoObservação
inquilinoCódigo do InquilinoStringObrigatório
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Expandir
titleExemplo do retorno 200

{
  "success": true,
  "message": "string",
  "data": [
    {
      "id": 0,
      "idInquilino": "string",
      "dataAtualizacao": "2024-05-03T20:52:37.521Z",
      "dataCadastro": "2024-05-03T20:52:37.521Z",
      "idRetaguardaLoja": "string",
      "tipoDado": 1,
      "numeroRegistros": 0,
      "numeroRegistrosConfirmados": 0,
      "status": 0,
      "conteudo": "string",
      "observacao": "string"
    }
  ]
}

Expandir
titleDefinições do retorno 200

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 de caixadados consolidados
data.idLong (Int64)Código Único do Dado Consolidado
data.idInquilinoStringCódigo Id do Inquilino
data.dataAtualizacaoDateTimeData de Atualização do Registro
data.dataCadastroDateTimeData de Cadastro do Registro
data.idRetaguardaLojaStringCódigo Id Retaguarda da Loja
data.tipoDadoEnumTipo do Dados Consolidado (Vide as definições abaixo)
data.numeroRegistrosInt (Int32)Número de Registros Consolidados Enviados
data.numeroRegistrosConfirmadosInt (Int32)Número de Registros Consolidados Confirmados pela Retaguarda
data.statusInt (Int32)Status (Definições abaixo)
data.conteudoTextConteúdo do Consolidado em Base64 (Definições abaixo)
data.observacaoStringObservação (Pode ser utilizado como log)
Expandir
titleTipo Dado Consolidado
CódigoDescrição
1Venda
Expandir
titleStatus
CódigoDescrição
0Pendente
1Confirmado com Sucesso
2Confirmado com Erro
Expandir
titleConteúdo - Base 64

O conteúdo enviado em base64 segue o padrão abaixo:

[{
        "VendaId": 1967,
        "ChaveAcesso": "43240482373077000171655480000101371858920188",
        "SerieNota": 548,
        "ccf": "10137",
        "ValorBruto": 15.41,
        "DataAtualizacao": "2024-04-26T17:46:09.686751",
        "DataCadastro": "2024-04-26T17:44:18.427249",
        "DataEmissao": "2024-04-26T17:44:18.265702",
        "SituacaoVenda": 0,
        "IdRetaguardaLoja": "1",
        "NumeroPDV": "13"
    }]

Expandir
title400 - Bad Request

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
Expandir
titleBody de retorno

{
    "success": false,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}