TOTVS Varejo Franquias e Redes

Atalhos

Árvore de páginas

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


  • Endpoint: /api/pdvsyncserver/retaguarda/v2/ProcessoOnlineNotaSaida
  • 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
    DataInicio Datetime Data de início
    DataFim Datetime Data Fim
    CpfCnpj String Cpf ou Cnpj
    Serie String Serie
    Cupom String Cupom
    IdRetaguardaProduto String Identificador do Produto na retaguarda
    IdRetaguardaLoja String Identificador da loja na retaguarda
    Tipo Lista de String Tipos
    Pagina Int Página
    ItensPagina Int Quantidade de itens da página

    {
        "idInquilino": "string",
        "dataInicio": "2024-06-13T18:13:32.029Z",
        "dataFim": "2024-06-13T18:13:32.029Z",
        "cpfCnpj": "string",
        "serie": "string",
        "cupom": "string",
        "idRetaguardaProduto": "string",
        "idRetaguardaLoja": "string",
        "tipo": [
            "string"
        ],
        "pagina": 0,
        "itensPagina": 0
    }

    Retornos

      Campo

      Tipo

      Descrição
      Success Booleano 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.IdRetaguardaLoja String Identificador da loja na retaguarda
      Data.DataHora String Data e hora da nota
      Data.CpfCnpj String CPF ou CNPJ do cliente
      Data.ValorTotal Decimal Valor total da nota
      Data.Tipo String Tipo da nota
      Data.QtdItens Decimal Quantidade de itens da nota
      Data.Itens Lista de Objetos Itens da nota
      Data.Itens.Descricao String Descrição do item 
      Data.Itens.ValorUnitario Decimal Valor unitário do item
      Data.Itens.QtdVendida Decimal Quantidade vendida
      Data.Itens.QtdDisponivel Decimal Quantidade disponível
      Data.Itens.IdRetaguardaCupomItem String Identificador do cupom na retaguarda
      Data.Itens.IdRetaguardaProduto String Identificador do produto na retaguarda
      Data.Serie String Séria da nota
      Data.IdRetaguardaCupom String Identificador do cupom na retaguarda
      Data.Cupom String Cupom
      Data.Situacao String Situação
      Errors Lista de objetos Lista de erros
      TotalTime Inteiro Tempo da requisição
      NumberOfRecords Inteiro Número de registros


      {
          "success": true,
          "message": "String",
          "data": [
              {
                  "idRetaguardaLoja": "String",
                  "dataHora": "13/06/2024 15:19:39",
                  "cpfCnpj": "String",
                  "valorTotal": 0.0,
                  "tipo": "String",
                  "qtdItens": 0.0,
                  "itens": [
                      {
                          "descricao": "String",
                          "valorUnitario": 0.0,
                          "qtdVendida": 0.0,
                          "qtdDisponivel": 0.0,
                          "idRetaguardaCupomItem": "String",
                          "idRetaguardaProduto": "String"
                      }
                  ],
                  "serie": "String",
                  "idRetaguardaCupom": "String",
                  "cupom": "String",
                  "situacao": "String"
              }
          ],
          "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