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 |
|---|
| listIdProprietario* | Lista de Proprietário para filtro | Lista de objetos | Opcional |
Obs.: Os campos em * devem ser enviados no Header do GET.
...
| 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": "Stringstring",
"data": [
{
"tipoid": 0,
"statusidInquilino": 0,
"conteudo": "String",
"string",
"numeroLojadataAtualizacao": "String",
"numeroCaixa": "String",
"dataHora": "datetime2024-05-03T20:52:37.521Z",
"tipoMovimentodataCadastro": "String",
"observacao": "String",
"id": "String"2024-05-03T20:52:37.521Z",
"idInquilinoidRetaguardaLoja": "Stringstring",
"idRetaguardatipoDado": "String"1,
"dataAtualizacaonumeroRegistros": "datetime"0,
"dataCadastronumeroRegistrosConfirmados": "datetime"0,
"idProprietariostatus": "String"0,
"loteOrigemconteudo": "Stringstring",
"loteobservacao": "Stringstring"
}
],
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| 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.tipo | Inteiro | id | Long (Int64) | Código Único do Dado ConsolidadoTipo do caixa | | data.statusidInquilino | InteiroString | Status Código Id do caixaInquilino | | data.conteudodataAtualizacao | StringDateTime | Conteúdo do caixa em base64Data de Atualização do Registro | | data.numeroLojadataCadastro | String | DateTime | Data de Cadastro do RegistroNúmero da loja | | data.numeroCaixaidRetaguardaLoja | StringNúmero do caixa | Código Id Retaguarda da Loja | | data.dataHoratipoDado | Data/HoraEnum | data do caixaTipo do Dados Consolidado (Vide as definições abaixo) | | data.tipoMovimento | String | numeroRegistros | Int (Int32) | Número de Registros Consolidados EnviadosTipo de movimente | | data.observacao | String | numeroRegistrosConfirmados | Int (Int32) | Número de Registros Consolidados Confirmados pela RetaguardaObservação | | data.id | String | status | Int (Int32) | Status (Definições abaixo)Identificador do caixa no POSH | | data.idInquilinoconteudo | StringText | Identificador do inquilinoConteúdo do Consolidado em Base64 (Definições abaixo) | | data.idRetaguardaobservacao | String | Identificador da Caixa na retaguarda | | data.dataAtualizacao | Data/Hora | Ultima atualização do caixa | | data.dataCadastro | Data/Hora | Data de cadastro do caixa | | 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 | Número de linhas afetadas| 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
} |
|
|
