Incluir Marcadores em um Pedido API 2.0
Serviço destinado a fazer inclusão de Marcadores em um Pedido de Venda.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| idPedido | string | obrigatório | Número de identificação do pedido no Tiny |
| marcadores (1) | - | obrigatório | Dados dos marcadores conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| marcadores[ ] | list | - | obrigatório | Elemento raiz utilizado para representar um conjunto Marcadores. |
| marcadores[ ].marcador | object | - | obrigatório | Elemento utilizado para representar um Marcador. |
| marcadores[ ].marcador.id (1) | inteiro | - | obrigatório | Número de identificação de um Marcador no Tiny. |
| marcadores[ ].marcador.descricao (1) (2) | string | 50 | obrigatório | Descrição do marcador |
(1) - Ao menos um desses parâmetros deve ser informado
(2) - Se a descrição informada não existir, será criado um novo marcador
Retorno do serviço
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | 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 | - | condicional | Conforme tabela "Códigos de erro" |
| retorno.erros[ ] (1) (2) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
| retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos do parâmetro marcadores
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/pedido.marcadores.incluir';
$token = 'coloque aqui a sua chave da api';
$marcadores = '<marcadores>...</marcadores>';
$idPedido = '11223344';
$data = "token=$token&marcadores=$marcadores&idPedido=$idPedido&formato=JSON";
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;
}
