Remover Marcadores em um Pedido API 2.0

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

Parâmetros do serviço

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idPedidostringobrigatórioNúmero de identificação do pedido no Tiny
marcadores (1)-obrigatórioDados dos marcadores conforme layout
formatostringobrigatórioFormato do retorno (json ou xml)

(1) - Layout do parâmetro marcadores

ElementoTipoTamanhoOcorrênciaDescrição
marcadores[ ]list-obrigatórioElemento raiz utilizado para representar um conjunto Marcadores.
marcadores[ ].marcadorobject-obrigatórioElemento utilizado para representar um Marcador.
marcadores[ ].marcador.id (1)inteiro-obrigatórioNúmero de identificação de um Marcador no Tiny.
marcadores[ ].marcador.descricao (1) (2)string 50obrigatórioDescriçã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

ElementoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatório raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (2)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem 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 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 de chamada da API

Exemplos da chamada em REST 


$url = 'https://SERVER_API_DIRapi2/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://SERVER_API_DIRapi2.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 de retorno da API

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>