Árvore de páginas

Este método é responsável pela criação de novos estoque
  • Endpoint: /api/retaguarda/v2/estoques
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

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

Para que a baixa do Estoque criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  14 = estoque

    Requisição

    Exemplo de body da requisição

    [
        {
            "codigoProduto": "string",
            "idInquilino": "string",
            "idProprietario": "string",
            "idRetaguarda": "string",
            "idRetaguardaProduto": "string",
            "loteOrigem": "string",
            "saldo": "string",
            "situacao": 0
        }
    ]

    Definições dos campos do body

    Campo

    Tipo

    Descrição

    Obrigatório

    Observações

    idRetaguardaProduto String Identificador do produto na retaguarda Sim Tamanho máximo: 100 caracteres
    codigoProduto String Código do produto Sim
    saldo String Saldo do estoque do produto Sim
    situacao Inteiro Situação do estoque  Sim 0 - Inativo, 1 - Ativo
    idInquilino String Identificador do inquilino Sim
    idRetaguarda String Identificador do estoque na retaguarda Sim Tamanho máximo: 100 caracteres
    idProprietario String Identificador do proprietário Sim
    loteOrigem String Identificador do lote em que os dados serão enviados Sim

    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

      Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.

      Requisição

      Exemplo de body da requisição

      [
          {
              "dataAtualizacaoPaf": "2000-01-01",
              "idInquilino": "string",
              "idProprietario": "string",
              "idRetaguarda": "string",
              "idRetaguardaProduto": "string",
              "loteOrigem": "string",
              "saldo": 0,
              "saldoPaf": 0.0,
              "situacao": 0
          }
      ]

      Definições dos campos do body

      Campo

      Tipo

      Descrição

      Obrigatório

      Observações

      idRetaguardaProduto String Identificador do produto na retaguarda Sim Tamanho máximo: 100 caracteres
      saldoPaf numérico Saldo PAF Não
      saldo Int Saldo do estoque do produto Sim
      situacao Inteiro Situação do estoque  Sim 0 - Inativo, 1 - Ativo
      idInquilino String Identificador do inquilino Sim
      idRetaguarda String Identificador do estoque na retaguarda Sim Tamanho máximo: 100 caracteres
      idProprietario String Identificador do proprietário Sim
      loteOrigem String Identificador do lote em que os dados serão enviados Sim
      dataAtualizacaoPaf Datetime Data de atualização do Paf Não

      Retornos

        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
        • Sem rótulos