Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do produto na Olist
formatostringobrigatórioFormato do retorno (json)

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados
retorno.erros[].errostring-condicionalMensagem descritiva do erro
retorno.produtoobject-condicionalElemento representando o produto
retorno.produto.idint-condicionalNúmero de identificação do produto
retorno.produto.nomestring120condicionalNome do produto
retorno.produto.codigostring30condicionalCódigo do produto
retorno.produto.unidadestring3condicionalUnidade do produto
retorno.produto.saldodecimal3condicionalSaldo em estoque
retorno.produto.saldoReservadodecimal3condicionalSaldo reservado em estoque
retorno.produto.depositos[]list-condicionalLista de depósitos
retorno.produto.depositos[].deposito.nomestring120condicionalNome do depósito
retorno.produto.depositos[].deposito.desconsiderarstring1condicionalDesconsidera saldo (S/N)
retorno.produto.depositos[].deposito.saldodecimal-condicionalSaldo no depósito
retorno.produto.depositos[].deposito.empresastring120condicionalApelido da empresa
Valores decimais utilizam ”.” (ponto) como separador de decimais (exemplo: “5.25”).
Campo saldoReservado retornado apenas se conta possui extensão “Reserva de Estoques” habilitada.
Campo desconsiderar indica se o saldo do depósito é considerado no total em estoque do produto.
Com extensão MultiEmpresas, configure “Considerar estoque para API” nas configurações da empresa.

​
Exemplo de chamada

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

enviarREST($url, $data);

​
Exemplos de retorno

​
Sucesso - Produto com estoque

{
  "retorno": {
    "status_processamento": "3",
    "status": "OK",
    "produto": {
      "id": "46829062",
      "codigo": "123",
      "nome": "produto teste",
      "unidade": "UN",
      "saldo": 10,
      "saldoReservado": 3,
      "depositos": [
        {
          "deposito": {
            "nome": "Deposito 1",
            "desconsiderar": "N",
            "saldo": 5,
            "empresa": "Tiny"
          }
        },
        {
          "deposito": {
            "nome": "Deposito 2",
            "desconsiderar": "N",
            "saldo": 5,
            "empresa": "Tiny"
          }
        },
        {
          "deposito": {
            "nome": "Deposito 3",
            "desconsiderar": "N",
            "saldo": 0,
            "empresa": "Tiny"
          }
        }
      ]
    }
  }
}

​
Erro - Token inválido

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

​
Erro - Produto não localizado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 32,
    "erros": [
      {
        "erro": "Produto não localizado"
      }
    ]
  }
}