Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

IdInquilinoStringCódigo do Id do InquilinoObrigatório
DataAtualizacaoDateTimeData de Atualização do RegistroObrigatório
DataCadastroDateTimeData de Criação do RegistroObrigatório
IdRetaguardaLojaStringCódigo do Id Retaguarda da LojaObrigatório
TipoDadoEnumTipo do Dado Consolidado (Valores atribuídos no quadro abaixo)Obrigatório
NumeroRegistrosIntegerNúmero de Registros Enviados para o RetaguardaObrigatório
NumeroRegistrosConfirmadosIntegerNúmero de Registros Confirmados pelo RetaguardaOpcional (Nesse primeiro momento, enviar esse campo com o valor igual à 0) 
StatusIntegerStatus da confirmação do Dado Consolidado (Valores atribuídos no segundo quadro abaixo)Obrigatório
ConteudoTextConteúdo do Dado Consolidado em Base64 (Definições abaixo)Obrigatório
ObservacaoStringObservação (pode ser utilizado como Log)Opcional

...

Expandir
titleStatus
CódigoStatusDescrição
0Pendente*Pendente de confirmação do Retaguarda
1Confirmado com SucessoRecebimento confirmado com sucesso pela Retaguarda
2Confirmado com ErroRecebimento confirmado com erro

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

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
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do dado consolidado foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do dado consolidado eles serão enviados nesse campo
DataobjetoObjeto dado consolidado criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeintTempo da requisição
NumberOfRecordsintNúmero de dados inseridos
Expandir
titleBody de retorno

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

Expandir
title400 - Bad Request

Campo

Tipo

Descrição

SuccessboolIndica se a criação do dado consolidado foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do dado consolidado eles serão enviados nesse campo
DataobjetoObjeto dado consolidado 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
}