TOTVS Varejo PDV Omni

Árvore de páginas

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

Body da requisição

    Campo

    Tipo

    Descrição

    Obrigatório
    IdInquilino String Identificador do inquilino Sim
    idRetaguardaLoja String Identificador da loja na retaguarda Sim
    cliente Objeto Objeto de cliente  Validado no Retaguarda
    cliente.cpfCnpj String CPF ou CNPJ do cliente Validado no Retaguarda
    cliente.nome String Nome do cliente Validado no Retaguarda
    cliente.endereco String Endereço do cliente Validado no Retaguarda
    cliente.municipio String Município do cliente Validado no Retaguarda
    cliente.uf String Unidade Federativa do cliente Validado no Retaguarda
    itens Lista de Objetos Lista de Itens Validado no Retaguarda
    itens[].idRetaguardaCupomItem String Identificador do Item do cupom na retaguarda Validado no Retaguarda
    itens[].quantidade Int Quantidade Validado no Retaguarda
    dadosCustomizados Lista 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.

    {
        "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

      Campo

      Tipo

      Descrição
      Success bool Indica se a requisição foi feita com sucesso
      Message String Mensagem de retorno de erros
      Data Lista de Objetos Lista com os créditos retornados
      Data.ValorCredito Double Valor do crédito
      Data.IdRetaguardaNota String Identificador da nota na retaguarda
      Data.IdRetaguardaCredito String Identificador do crédito na retaguarda
      dadosCustomizados Lista de Objetos Lista com dados Customizados
      Errors Lista de objetos Lista de erros
      TotalTime Int Tempo da requisição
      NumberOfRecords Int Nú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
      }

      Campo

      Tipo

      Descrição

      Observação
      Success bool Indica se a requisição foi feita com sucesso
      Message string Mensagem de retorno de erros
      Data Objeto Objeto de retorno
      Errors Lista de objetos Lista de erros Somente é retornado na V3
      TotalTime Int Tempo total da requisição
      NumberOfRecords Int Número de registros


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

      • Sem rótulos