Árvore de páginas

Versões comparadas

Chave

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

Este método é responsável pela criação da nota de entrada

Ao realizarmos uma troca no PDV, quando devidamente parametrizado, ocorrerá um POST na API de processoonlinenotaentrada,  sendo possível disponibilizar os dados da troca/nota de entrada para a retaguarda.


  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinenotaentrada
  • Método: POST
  • Autenticação: Bearer token
  • Permissão: Client

...

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoStringIdentificador do inquilinoSim
idRetaguardaLojaStringIdentificador da loja na retaguardaSim
clienteObjetoObjeto de cliente Validado no Retaguarda
cliente.cpfCnpjStringCPF ou CNPJ do clienteValidado no Retaguarda
cliente.nomeStringNome do clienteValidado no Retaguarda
cliente.enderecoStringEndereço do clienteValidado no Retaguarda
cliente.municipioStringMunicípio do clienteValidado no Retaguarda
cliente.ufStringUnidade Federativa do clienteValidado no Retaguarda
itensLista de ObjetosLista de ItensValidado no Retaguarda
itens[].idRetaguardaCupomItemStringIdentificador do Item do cupom na retaguardaValidado no Retaguarda
itens[].quantidadeIntQuantidadeValidado no Retaguarda
dadosCustomizadosLista de Objetos

Lista genérica que pode conter N itens 
(Opcional)

Validado no Retaguarda


  • dadosCustomizados
    • O PDVSync irá criar esse objeto seguindo o modelo abaixo:
      •   "dadosCustomizados": { "vendedor": "12354123",
                                                   "data": "2023-10-04T10:30:00",
                                                   "motivo": "Devolução de item com defeito",
                                                   "quantidade": 5,
                                                   "valorTotal": 249.99,
                                                   "processado": true,
                                                   "comentarios": "Cliente solicitou devolução devido a um defeito no produto.",
                                                   "numeroPedido": "789456123",
                                                   "formaPagamento": "Cartão de Crédito",
                                                   "autorizacaoGerente": "Jose da Silva" }
    • É importante estar claro que é apenas um exemplo o modelo acima, pois o PDV poderá enviar N atributos, os quais não sabemos a descrição e nem o conteúdo.
Card
labelBody

{
    "idInquilino": "string",
    "idRetaguardaLoja": "string",
    "cliente": {
        "cpfCnpj": "string",
        "nome": "string",
        "endereco": "string",
        "municipio": "string",
        "uf": "string"
    },
    "itens": [
        {
            "idRetaguardaCupomItem": "string",
            "quantidade": 0
        }
    ],
    "dadosCustomizados": [
        {
            "vendedor": "12354123",
            "data": "2024-11-07T18:26:01.2397998+00:00",
            "motivo": "Devolução de item com defeito",
            "quantidade": 5,
            "valorTotal": 249.99,
            "processado": true,
            "comentarios": "Cliente solicitou devolução devido a um defeito no produto.",
            "numeroPedido": "789456123",
            "formaPagamento": "Cartão de Crédit",
            "autorizacaoGerente": "Jose da Silva"
        }
    ]
}

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno de erros
DataLista de ObjetosLista com os créditos retornados
Data.ValorCreditoDoubleValor do crédito
Data.IdRetaguardaNotaStringIdentificador da nota na retaguarda
Data.IdRetaguardaCreditoStringIdentificador do crédito na retaguarda
dadosCustomizadosLista de ObjetosLista com dados Customizados
ErrorsLista de objetosLista de erros
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros

{
    "success": false,
    "message": "String",
    "data": [
        {
            "valorCredito": 0.0,
            "idRetaguardaNota": "String",
            "idRetaguardaCredito": "String"
        }
    ],

 "dadosCustomizados": {
                "vendedor": "12354123",
                "data": "2024-10-08T14:04:54.1165244-03:00",
                "motivo": "Devolução de item com defeito",
                "quantidade": 5,
                "valorTotal": 249.99,
                "processado": true,
                "comentarios": "Cliente solicitou devolução devido a um defeito no produto.",
                "numeroPedido": "789456123",
                "formaPagamento": "Cartão de Crédit",
                "autorizacaoGerente": "Jose da Silva"
            }
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retorno
ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros


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