TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela alteração do status da venda, API utilizada pelo PDVOmni para alterar o status da pré venda.

O fluxo para atualização ocorre seguindo os passos abaixo:

1. PDVOmni -> 2. PDVSync -> 3. Retaguarda -> 4. PDVSync -> 5.PDVOmni.

  • O PDVOmni faz a requisição na API ProcessoOnlinePreVenda onde são enviados os parâmetros conforme está descrito em Detalhes da Requisição.
  • Ocorre a requisição na API de atualização no retaguarda. (Definições para criação abaixo).
  • O Retaguarda processa a requisição e devolve para o PDVSync.
  • O PDVSync recebe o retorno da retaguarda e devolve para o PDVOmni.
  • O PDVOmni recebe o retorno do PDVSync.
  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlineprevenda
  • Método: PATCH
  • Autenticação: Bearer token
  • Permissão: Client

Body da requisição

    Campo

    Tipo

    Descrição

    Obrigatório
    Id String Identificador Validado pela Retaguarda
    IdRetaguarda String Identificador da pré venda na retaguarda Validado pela Retaguarda
    Situacao Inteiro Situação da pré venda Validado pela Retaguarda
    SituacaoPreVenda String Status da pré venda  (Status abaixo) Validado pela Retaguarda
    IdInquilino String Identificador do inquilino Validado pela Retaguarda
    IdProprietario String Identificador do proprietário Validado pela Retaguarda
    • DISPONIVEL
    • ATENDIMENTO
    • FATURADO PARCIALMENTE
    • RESGATADA
    • RECEBIDO
    • CANCELADA

     {
         "id": "string",
         "idRetaguarda": "string",
         "situacao": 0,
         "situacaoPreVenda": "string",
         "IdInquilino": "string",
         "idProprietario": "string"
     }

    Retornos

      Campo

      Tipo

      Descrição
      Success Boolean Indica se a requisição foi feita com sucesso
      Message String Mensagem de retorno de erros
      Data Objeto Lista com os créditos retornados
      Data.IdPedidoRetaguarda String Identificador do Pedido na retaguarda
      Data.Cliente Objeto Objeto do cliente
      Data.Cliente.Enderecos Lista de objetos Lista de endereços do cliente
      Data.Cliente.Enderecos.Id Inteiro Identificador do endereço
      Data.Cliente.Enderecos.IdRetaguarda String Identificador do endereço na retaguarda
      Data.Cliente.Id Inteiro Identificador do cliente
      Data.Cliente.IdRetaguarda String Identificador do cliente na retaguarda
      Errors Objeto Lista de erros
      TotalTime Inteiro Tempo da requisição
      NumberOfRecords Inteiro Número de registros

      {
          "success": true,
          "message": "string",
          "data": {
              "idPedidoRetaguarda": "string",
              "cliente": {
                  "enderecos": [
                      {
                          "id": 0,
                          "idRetaguarda": "string"
                      }
                  ],
                  "id": 0,
                  "idRetaguarda": "string"
              }
          },
          "errors": {},
          "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