TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela criação dos dados de observação adicional capa, ao realizarmos uma requisição na API de dados dinamicos (dadosdinamicos/down/106) , serão criadas as informações que serão enviadas para o PDV.

  • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/106/1
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Este endpoint recebe uma lista de observação adicional capa para que possam ser enviados vários na mesma requisição

Para que a baixa da observação adicional capa ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 106 = observação adicional capa

    Requisição

    Exemplo de body da requisição

    [
        {
            "idRetaguarda": "string",
            "idInquilino": "string",
            "idProprietario": "string",        
            "loteOrigem": "string",
            "titulo":"text",
            "subtitulo":"text",
            "nomeFuncionalidade":"text",
            "tipoRotina":10,
            "situacao": 0,
            "momentoRotina":0,
            "dataCadastro":"2021-06-21T14:43:18.665Z",
            "dataAtualizacao":"2021-06-21T14:43:18.665Z"
        }
    ]


    Definições dos campos do body

    Campo Tipo Descrição Obrigatório Observações
    idRetaguarda string Identificação no retaguarda Sim
    idInquilino string Identificação do inquilino Sim
    idProprietario string

    Identificador do proprietário

    Sim


    loteOrigem string Identificação da origem do lote Sim
    titulo string Titulo da observação capa Sim Tamanho máximo: 50 caracteres
    subtitulo string Subtitulo da observação capa Não Tamanho máximo: 50 caracteres
    nomeFuncionalidade string Nome da funcionalidade Sim Tamanho máximo: 20 caracteres
    tipoRotina Inteiro Tipo da rotina Sim 0 = Troca
    1 = Cliente
    situacao Inteiro Situação da observação capa Sim

    Define se a observação em questão está ativa ou inativa.

    • 0 - Inativo
    • 1 - Ativo
    momentoRotina Inteiro Momento da rotina Sim

    Define se momento da observação.

    • 0 - Inicialização
    • 1 - Finalização
    dataCadastro DateTime

    Data do cadastro

    		 Não


    dataAtualizacao DateTime

    Data da Atualização

    		 Não


    Retorno

      Exemplo de body de retorno

      {
          "success": true,
          "message": "Requisição inserida com sucesso!",
          "data": null,
          "errors": null,
          "totalTime": 0,
          "numberOfRecords": 0
      }

      Definições dos campos do retorno

      Campo

      Tipo

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

      Exemplo de body de retorno

      {
          "code": "string",
          "message": "string",
          "detailedMessage": "string",
          "helpUrl": "string",
          "details": [
              {
                  "guid": "string",
                  "code": "string",
                  "message": "string",
                  "detailedMessage": "string"
              }
          ]
      }

      Definições dos campos do retorno

      Campo

      Tipo

      Descrição
      code string Código de erro
      message string Mensagem do erro
      detailedMessage string Detalhamento do erro
      helpUrl string url de ajuda
      TotalTime string Tempo total de busca
      details lista de objeto Lista de objeto de erros
      details.guid string Identificador do erro
      details.code string Código do erro
      details.message string Mensagem do erro 
      details.detailedMessage string Detalhamento do erro

      O Dado dinâmico é uma nova forma para envio de dados entre PDV e Retaguarda.

      Para o envio de condição de pagamento pelo Dado dinâmico,  realizar um requisição o seguinte endpoint

      • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/{TipoDado}/{VersãoDado}
      • Método: Post
      • Autenticação: Bearer token
      • Permissão: Retaguarda

      Versão dado

      Versão requisição Versão dado
      V3.1 1
      V3.2 2

      A propriedade {Versão Dado}, enviado na URL da requisição, deve ser substituído pela versão do dado que será enviado.

      O body da requisição é o mesmo enviado no endpoint padrão. Consulte as outras abas dessa seção para ver o que deve ser enviado na requisição de acordo com a versão dado enviado na URL.

      • Sem rótulos