POST /api/retaguarda/v2/dadoConsolidados

API responsável por enviar os dados consolidados de venda, caixa ou operações do TOTVS PDV Omni através do PDVSync.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

Endpoint: /api/pdvsyncclient/v2/dadoConsolidados
Método: POST
Autenticação: Bearer token
Permissão: Client

O endpoint recebe uma lista de dados consolidados para que seja possivel enviar várias na mesma requisição.

Exemplo de body da requisição

[
{
"idInquilino": "string",
"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"
}
]

Definição dos campos de requisição

Campo	Tipo	Descrição	Observações
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	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
NumeroRegistrosConfirmados	Integer	Número de Registros Confirmados pelo Retaguarda	Opcional (Nesse primeiro momento,
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	Obrigatório
Observacao	String	Observação (pode ser utilizado como Log)	Opcional

Tipo Dado Consolidado

Código	Status
1	Venda

Status

Código	Status	Descrição
0	Pendente*	Pendente de confirmação do Retaguarda
1	Confirmado com Sucesso	Recebimento confirmado com sucesso pela Retaguarda
2	Confirmado com Erro	Recebimento confirmado com erro

* O serviço PDVSync.Client.Servico.Up sempre irá enviar o Dado Consolidado com o status 0 (Pendente).

Definição dos campos de retorno

200 - Ok

Campo	Tipo	Descrição
Success	bool	Indica se a criação do dado consolidado foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do dado consolidado eles serão enviados nesse campo
Data	objeto	Objeto dado consolidado criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	Tempo da requisição
NumberOfRecords	int	Número de dados inseridos

Body de retorno

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

400 - Bad Request

Campo	Tipo	Descrição
Success	bool	Indica se a criação do dado consolidado foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do dado consolidado eles serão enviados nesse campo
Data	objeto	Objeto dado consolidado criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	Tempo da requisição
NumberOfRecords	int	Número de dados inseridos

Body de retorno

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

Atalhos

Árvore de páginas