Endpoint
POST https://api.tiny.com.br/api2/lista.atualizacoes.estoque
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| dataAlteracao | string | obrigatório | Data de alteração em formato dd/mm/yyyy hh:mm:ss (aceita apenas data: 01/01/2011 ou data e hora: 01/01/2012 15:30:00) |
| formato | string | obrigatório | Formato do retorno (json) |
| pagina | int | opcional | Número da página desejada; padrão listado = 100 registros por página; valor padrão = 1 |
Retorno
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|
| retorno | object | - | obrigatório | Elemento raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Conforme tabela “Status de Processamento” |
| retorno.status | string | - | obrigatório | Status do retorno: “OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Conforme tabela “Códigos de erro” (só se status = Erro) |
| retorno.erros[] | list | - | condicional | Lista dos erros encontrados |
| retorno.erros[].erro | string | - | condicional | Mensagem descritiva do erro |
| retorno.produtos[] | list | - | condicional | Lista de resultados da pesquisa |
| retorno.produtos[].produto | object | - | condicional | Elemento que representa um produto |
| retorno.produtos[].produto.id | int | - | condicional | Número de identificação do produto na Olist |
| retorno.produtos[].produto.nome | string | 120 | condicional | Nome do produto |
| retorno.produtos[].produto.codigo | string | 30 | condicional | Código do produto |
| retorno.produtos[].produto.unidade | string | 3 | condicional | Unidade do produto |
| retorno.produtos[].produto.tipo_variacao | string | 1 | condicional | Tipo de variação (N=Normal, P=Produto pai, V=Produto variação) |
| retorno.produtos[].produto.localizacao | string | 50 | condicional | Localização física no estoque |
| retorno.produtos[].produto.data_alteracao | datetime | - | condicional | Data de alteração do estoque (formato: dd/mm/yyyy hh:mm:ss) |
| retorno.produtos[].produto.saldo | decimal | 3 | condicional | Saldo em estoque |
| retorno.produtos[].produto.saldoReservado | decimal | 3 | condicional | Saldo reservado em estoque |
| retorno.produtos[].depositos[] | list | - | condicional | Lista de depósitos |
| retorno.produtos[].depositos[].deposito | object | - | condicional | Elemento que representa um depósito |
| retorno.produtos[].depositos[].deposito.nome | string | 120 | condicional | Nome do depósito (ex: Loja, Depósito X) |
| retorno.produtos[].depositos[].deposito.desconsiderar | string | 1 | condicional | Desconsidera o saldo do depósito (S/N) |
| retorno.produtos[].depositos[].deposito.saldo | decimal | - | condicional | Saldo do estoque no depósito |
Valores decimais utilizam ”.” (ponto) como separador de decimais.
Data de alteração utiliza formato “dd/mm/yyyy hh:mm:ss”.
Campo saldoReservado retornado apenas se a conta possui a extensão Reserva de Estoques habilitada.
Campo desconsiderar indica se o saldo do depósito é considerado no total em estoque do produto.
Você pode acessar a página de Extensões da Olist e instalar a extensão “API para estoque em tempo real” para utilizar este serviço.
Exemplo de chamada
curl -X POST https://api.tiny.com.br/api2/lista.atualizacoes.estoque \
-d "token=SUA_CHAVE_API&dataAlteracao=01/01/2023&formato=json"
Exemplos de retorno
Sucesso
{
"retorno": {
"status_processamento": "3",
"status": "OK",
"produtos": [
{
"produto": {
"id": "751816175",
"nome": "65 Super Reverb® teste Jon - P - Azul",
"codigo": "000k4-1",
"unidade": "UN",
"tipo_variacao": "V",
"localizacao": "Depósito A",
"saldo": 10,
"saldoReservado": 0,
"depositos": [
{
"deposito": {
"nome": "Geral",
"desconsiderar": "N",
"saldo": 10
}
},
{
"deposito": {
"nome": "meu depósito",
"desconsiderar": "S",
"saldo": 0
}
}
]
}
}
]
}
}
Erro - Token inválido
{
"retorno": {
"status_processamento": 1,
"status": "Erro",
"codigo_erro": 2,
"erros": [
{
"erro": "token invalido"
}
]
}
}
Erro - Consulta sem registros
{
"retorno": {
"status_processamento": 2,
"status": "Erro",
"codigo_erro": 20,
"erros": [
{
"erro": "A Consulta não retornou registros"
}
]
}
}
