API responsável por enviar os dados consolidados de venda/, caixa /ou operações do TOTVS PDV Omni através do serviço UPPDVSync.Client.Serviço.UP (Serviço responsável pela subida de dados do TOTVS PDV Omni para o retaguarda).
IMPORTANTE: API de uso exclusivo do client.
Para acessar os dados a requisição é a seguinte
...
O endpoint recebe uma lista de vendas dados consolidados para que seja possivel enviar várias na mesma requisição.
| Expandir |
|---|
| title | Exemplo de body da requisição |
|---|
|
[
{
"idMensagemidInquilino": "string",
"observacao"dataAtualizacao": "2024-05-06T14:35:08.208Z",
"dataCadastro": "2024-05-06T14:35:08.208Z",
"idRetaguardaLoja": "string",
"tipoDado": 1,
"numeroRegistros": 0,
"numeroRegistrosConfirmados": 0,
"status": 0,
"conteudo": "string",
"observacao": "string"
}
] |
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Observações |
|---|
idMensagem |
|---|
| IdInquilino | String | Código do Id do Inquilino | Obrigatório | | DataAtualizacao | DateTime | Data de Atualização do Registro | Obrigatório | | DataCadastro | DateTime | Data de Criação do Registro | Obrigatório | | IdRetaguardaLoja | String |
Identificador da venda no POSH| Código do Id Retaguarda da Loja | Obrigatório | | TipoDado | Enum | Tipo do Dado Consolidado (Valores atribuídos no quadro abaixo) | Obrigatório | | NumeroRegistros | Integer | Número de Registros Enviados para o Retaguarda | Obrigatório |
observacao| NumeroRegistrosConfirmados |
String | Observação enviada pela retaguarda | Opcional | | Integer | Número de Registros Confirmados pelo Retaguarda | Opcional (Nesse primeiro momento, enviar esse campo com o valor igual à 0) | | Status | Integer | Status da confirmação do Dado Consolidado (Valores atribuídos no segundo quadro abaixo) | Obrigatório | | Conteudo | Text | Conteúdo do Dado Consolidado em Base64 (Definições abaixo) | Obrigatório | | Observacao | String | Observação (pode ser utilizado como Log |
status | Int | Status da venda (Definições abaixo |
| Expandir |
|---|
| title | Tipo Dado Consolidado |
|---|
|
|
| Expandir |
|---|
|
| Código | Status | Descrição |
|---|
| 0 | ProcessarPendente | Pendente consumo pela retaguardade confirmação do Retaguarda | | 1 | Processada | Confirmado com Sucesso | Recebimento confirmado com sucesso pela RetaguardaConsumido pela retaguarda | | 2 | Confirmado com Erro | Consumido com erro pela retaguarda | | 3 | Reprocessar | Para reprocessar | 4 | IntegradoComSucesso | Integrado com sucesso pela retaguarda| Recebimento confirmado com erro |
* O serviço PDVSync.Client.Servico.Up sempre irá enviar o Dado Consolidado com o status 0 (Pendente). |
| 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 |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento dado consolidado foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento dado consolidado eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento dado consolidado criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo Tempo da requisição | | NumberOfRecords | int | número Número de dados inseridos |
| Expandir |
|---|
| {
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
|
| Expandir |
|---|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento dado consolidado foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento dado consolidado eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento dado consolidado criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo Tempo da requisição | | NumberOfRecords | int | número Número de dados inseridos |
| Expandir |
|---|
| {
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
|
|
