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âmetro | Descrição | Tipo | Observação |
---|
inquilino | Código do Inquilino | String | Obrigatório |
Expandir |
---|
title | Definição dos campos de retorno |
---|
|
Expandir |
---|
| Expandir |
---|
title | Exemplo 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 |
---|
title | Definições do retorno 200 |
---|
| Campo | Tipo | Descrição |
---|
success | Booleano | 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 | Lista de Objetos | Lista de caixadados consolidados | data.id | Long (Int64) | Código Único do Dado Consolidado | data.idInquilino | String | Código Id do Inquilino | data.dataAtualizacao | DateTime | Data de Atualização do Registro | data.dataCadastro | DateTime | Data de Cadastro do Registro | data.idRetaguardaLoja | String | Código Id Retaguarda da Loja | data.tipoDado | Enum | Tipo do Dados Consolidado (Vide as definições abaixo) | data.numeroRegistros | Int (Int32) | Número de Registros Consolidados Enviados | data.numeroRegistrosConfirmados | Int (Int32) | Número de Registros Consolidados Confirmados pela Retaguarda | data.status | Int (Int32) | Status (Definições abaixo) | data.conteudo | Text | Conteúdo do Consolidado em Base64 (Definições abaixo) | data.observacao | String | Observação (Pode ser utilizado como log) |
|
Expandir |
---|
title | Tipo Dado Consolidado |
---|
| |
Expandir |
---|
| Código | Descrição |
---|
0 | Pendente | 1 | Confirmado com Sucesso | 2 | Confirmado com Erro |
|
Expandir |
---|
| 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 |
---|
| 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 |
Expandir |
---|
| { "success": false, "message": "", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
|
|