Atualizar estoque do produto API 2.0
Serviço destinado a atualizar o estoque de um produto.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
estoque (1) | - | obrigatório | Dados do estoque conforme layout |
formato | string | obrigatório | Formato do retorno (json ou xml) |
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
estoque | object | - | obrigatório | Elemento utilizado para representar um lançamento de estoque. |
estoque.idProduto | int | obrigatório | Número de identificação do Produto no Tiny. | |
estoque.tipo (1) | string | 1 | opcional | Tipo do lançamento. Padrão 'B'. |
estoque.data (2) | datetime | 19 | opcional | Data do lançamento. Padrão é a data atual. |
estoque.quantidade (3) | decimal | - | obrigatório | Quantidade do lançamento. |
estoque.precoUnitario (3) | decimal | - | opcional | Preço unitário do lançamento. |
estoque.observacoes | string | 100 | opcional | Observações do lançamento. |
estoque.deposito | string | 100 | opcional | Nome do depósito. Se não for enviado, será usado o padrão. |
(1) - Os tipos podem ser: 'E' (entrada, onde acrescenta-se o valor informado no campo quantidade ao estoque atual),
'S' (saída, onde diminui-se o valor informado no campo quantidade ao estoque atual) ou
'B' (balanço, onde o valor informado no campo quantidade vira o estoque atual).
(2) - Formato Y-m-d H:i:s. Ex: 2017-03-05 16:08:54.
(3) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
Retorno do serviço
Elemento | 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 | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
retorno.codigo_erro (1) | int | - | obrigatório | Conforme tabela "Códigos de erro" |
retorno.erros[ ] (1) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.registros[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
retorno.registros[ ].registro (2) | object | - | condicional | Elemento utilizado para representar um lançamento de estoque. |
retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada lançamento. |
retorno.registros[ ].registro.status | string | - | condicional | Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
retorno.registros[ ].registro.codigo_erro | int | - | condicional | Conforme tabela "Códigos de erro" |
retorno.registros[ ].registro.erros[ ] (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.registros[ ].registro.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.registros[ ].registro.id | int | - | obrigatório | Número de identificação do lançamento de estoque no Tiny |
retorno.registros[ ].registro.saldoEstoque | decimal | - | obrigatório | Saldo em estoque do produto após o lançamento. |
retorno.registros[ ].registro.saldoReservado(4) | decimal | - | condicional | Saldo reservado em estoque. |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Este campo é retornado apenas se a conta possui a extensão Reserva de Estoques habilitada.
Exemplos do parâmetro produto
<?xml version="1.0" encoding="UTF-8"?>
<estoque>
<idProduto>12345888</idProduto>
<tipo>E</tipo>
<data>2017-03-27 13:03:00</data>
<quantidade>7</quantidade>
<precoUnitario>25.78</precoUnitario>
<observacoes>observação do lançamento</observacoes>
<deposito>deposito central</deposito>
</estoque>
Exemplos de chamada da API
$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=XML";
enviarREST($url, $data);
function enviarREST($url, $data, $optional_headers = null) {
$params = array('http' => array(
'method' => 'POST',
'content' => $data
));
if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}
$ctx = stream_context_create($params);
$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problema com $url, $php_errormsg");
}
$response = @stream_get_contents($fp);
if ($response === false) {
throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
}
return $response;
}
$client = new nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;
$result = $client->call("atualizarEstoqueProdutoService", array('token' => 'xxxxx','estoque'=>'<estoque>...</estoque>','formato'=>'XML'));
$res = array();
if ($client->fault) {
$retorno = $result['faultstring'];
} else {
$err = $client->getError();
if ($err) {
$retorno = $err;
} else {
$retorno = $result;
}
}
Exemplos de retorno da API
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>1</status_processamento>
<status>Erro</status>
<codigo_erro>2</codigo_erro>
<erros>
<erro>token invalido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>2</status_processamento>
<status>Erro</status>
<registros>
<registro>
<sequencia>1</sequencia>
<status>Erro</status>
<codigo_erro>32</codigo_erro>
<erros>
<erro>Campo idProduto inválido.</erro>
</erros>
</registro>
</registros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<registros>
<registro>
<sequencia>1</sequencia>
<status>OK</status>
<id>123123</id>
<saldoEstoque>3.00</saldoEstoque>
<saldoReservado>1.00</saldoReservado>
</registro>
</registros>
</retorno>