Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/produto.atualizar.estoque.php

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
estoqueobjectobrigatórioDados do estoque conforme layout
formatostringobrigatórioFormato do retorno (json)

​
Estrutura do parâmetro “estoque”

CampoTipoTamanhoOcorrênciaDescrição
estoqueobject-obrigatórioElemento para representar lançamento de estoque
estoque.idProdutoint-obrigatórioIdentificação do produto na Olist
estoque.tipostring1opcionalTipo de lançamento. Padrão ‘B’
estoque.datadatetime19opcionalData do lançamento. Padrão é a data atual
estoque.quantidadedecimal-obrigatórioQuantidade do lançamento
estoque.precoUnitariodecimal-opcionalPreço unitário do lançamento
estoque.observacoesstring100opcionalObservações do lançamento
estoque.depositostring100opcionalNome do depósito. Usa padrão se não enviado
Campo tipo aceita: ‘E’ = entrada (acrescenta ao estoque atual), ‘S’ = saída (diminui do estoque atual), ‘B’ = balanço (substitui o estoque atual).
Campo data formato: Y-m-d H:i:s (ex: 2017-03-05 16:08:54).
Valores decimais utilizam ”.” (ponto) como separador (ex: 5.25).

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela de Status de Processamento
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-obrigatórioConforme tabela de Códigos de Erro
retorno.erros[]list-condicionalLista dos erros encontrados
retorno.erros[].errostring-condicionalDescrição do erro
retorno.registros[]list-condicionalLista de resultados
retorno.registros[].registroobject-condicionalElemento de lançamento de estoque
retorno.registros[].registro.sequenciaint-condicionalNúmero sequencial do lançamento
retorno.registros[].registro.statusstring-condicional”OK” ou “Erro”
retorno.registros[].registro.codigo_erroint-condicionalCódigo de erro
retorno.registros[].registro.erros[]list-condicionalLista de erros
retorno.registros[].registro.erros[].errostring-condicionalDescrição do erro
retorno.registros[].registro.idint-obrigatórioIdentificação do lançamento de estoque
retorno.registros[].registro.saldoEstoquedecimal-obrigatórioSaldo em estoque após lançamento
retorno.registros[].registro.saldoReservadodecimal-condicionalSaldo reservado em estoque
retorno.registros[].registro.registroCriadoboolean-obrigatórioIndica se novo registro foi criado
Campo saldoReservado retornado apenas se extensão “Reserva de Estoques” está habilitada.
Em atualizações de balanço onde quantidade equals saldo atual, nenhum novo registro é criado; id retorna 0.

​
Exemplo de chamada

$url = 'https://api.tiny.com.br/api2/produto.atualizar.estoque.php';
$token = 'coloque aqui a sua chave da api';
$estoque = '<estoque>...</estoque>';
$data = "token=$token&estoque=$estoque&formato=JSON";

enviarREST($url, $data);

​
Exemplo de entrada (JSON)

{
  "estoque": {
    "idProduto": "12345888",
    "tipo": "E",
    "data": "2017-03-27 13:03:00",
    "quantidade": "7",
    "precoUnitario": "25.78",
    "observacoes": "observação do lançamento",
    "deposito": "deposito central"
  }
}

​
Exemplos de retorno

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": {
      "registro": {
        "sequencia": "1",
        "status": "OK",
        "id": "123123123",
        "saldoEstoque": "3.00",
        "saldoReservado": "1.00"
      }
    }
  }
}

​
Erro - Token inválido

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

​
Erro - Validação

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "32",
          "erros": [
            {
              "erro": "Campo idProduto inválido."
            }
          ]
        }
      }
    ]
  }
}