Remover Marcadores em um Pedido API 2.0

Serviço destinado a remover Marcadores em um Pedido de Venda.

REST
SOAP

REST URL

SOAP WSDL

WSDL Service

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 ⁽¹⁾	-	obrigatório	Dados dos marcadores conforme layout
formato	string	obrigatório	Formato do retorno (json ou xml)

(1) - Layout do parâmetro marcadores

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 ⁽¹⁾	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

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 ⁽¹⁾	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 em JSON

Exemplos do parâmetro marcadores em XML

<?xml version="1.0" encoding="UTF-8"?>
<marcadores>
  <marcador>
    <id>112233</id>
    <descricao/>
  </marcador>
  <marcador>
    <id/>
    <descricao>Teste</descricao>
  </marcador>
</marcadores>

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/pedido.marcadores.remover';
$token = 'coloque aqui a sua chave da api';
$marcadores = '<marcadores>...</marcadores>';
$idPedido = '11223344';
$data = "token=$token&marcadores=$marcadores&idPedido=$idPedido&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;
}

Exemplos da chamada em SOAP


$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("removerMarcadoresPedidoService", array('token' => 'xxxxx','marcadores'=>'<marcadores>...</marcadores>','idPedido'=>11223344,'formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>2</status_processamento>
  <status>Erro</status>
  <codigo_erro>32</codigo_erro>
  <erros>
    <erro>Pedido não localizado</erro>
  </erros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>2</status_processamento>
  <status>Erro</status>
  <codigo_erro>31</codigo_erro>
  <erros>
    <erro>Marcadores não preenchidos</erro>
  </erros>
</retorno>

Remover Marcadores em um Pedido API 2.0

Parâmetros do serviço

(1) - Layout do parâmetro marcadores

Retorno do serviço

Exemplos do parâmetro marcadores