Fechar
esqueci a minha senha
criar uma conta

Obter Pedido API 2.0

Serviço destinado a obter os dados de um Pedido.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do pedido no Tiny
formatostringobrigatórioFormato do retorno (json ou xml)
ElementoTipoTamanhoOcorrênciaDescrição
retorno--obrigatórioElemento 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) (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.pedido (2)object-condicionalElemento utilizado para representar um pedido.
retorno.pedido.idint-condicionalNúmero de identificação do pedido no Tiny
retorno.pedido.numeroint-condicionalNúmero do pedido no Tiny
retorno.pedido.numero_ecommercestring50condicionalNúmero do pedido no ecommerce(ou sistema)
retorno.pedido.data_pedido (4)date10opcionalData do pedido
retorno.pedido.data_prevista (4)date10opcionalData de previsão do pedido
retorno.pedido.id_lista_precoobjectopcionalNúmero de identificação da lista de preços no Tiny
retorno.pedido.descricao_lista_precoobjectopcionalDescrição da lista de preços
retorno.pedido.clienteobjectobrigatórioElemento utilizado para representar o cliente
retorno.pedido.cliente.codigostring30opcionalCódigo do cliente
retorno.pedido.cliente.nomestring30obrigatórioNome do cliente
retorno.pedido.cliente.nome_fantasiastring30opcionalNome fantasia do cliente
retorno.pedido.cliente.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.pedido.cliente.cpf_cnpjstring18opcionalCPF ou CNPJ do cliente
retorno.pedido.cliente.iestring18opcionalInscrição estadual do cliente
retorno.pedido.cliente.rgstring10opcionalRG do cliente
retorno.pedido.cliente.enderecostring50opcionalEndereço do cliente
retorno.pedido.cliente.numerostring10opcionalNúmero do endereço do cliente
retorno.pedido.cliente.complementostring50opcionalComplemento do endereço do cliente
retorno.pedido.cliente.bairrostring30opcionalBairro do cliente
retorno.pedido.cliente.cepstring10opcionalCep do cliente
retorno.pedido.cliente.cidadestring30opcionalNome da cidade do cliente conforme a Tabela de Cidades
retorno.pedido.cliente.ufstring30opcionalUF do cliente
retorno.pedido.cliente.paisstring50opcionalNome do País do cliente conforme Tabela de Países
retorno.pedido.cliente.fonestring40opcionalTelefone do cliente
retorno.pedido.cliente.emailstring50opcionalEmail do cliente
retorno.pedido.endereco_entregaobjectopcionalElemento utilizado para representar o endereço de entrega, caso seja diferente do endereço do cliente
retorno.pedido.endereco_entrega.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.pedido.endereco_entrega.cpf_cnpj string18opcionalCPF ou CNPJ de entrega
retorno.pedido.endereco_entrega.enderecostring50opcionalEndereço de entrega
retorno.pedido.endereco_entrega.numerostring10opcionalNúmero do endereço de entrega
retorno.pedido.endereco_entrega.complementostring50opcionalComplemento do endereço de entrega
retorno.pedido.endereco_entrega.bairrostring30opcionalBairro de entrega
retorno.pedido.endereco_entrega.cepstring10opcionalCep de entrega
retorno.pedido.endereco_entrega.cidadestring30opcionalNome da cidade de entrega conforme a Tabela de Cidades
retorno.pedido.endereco_entrega.ufstring30opcionalUF de entrega
retorno.pedido.endereco_entrega.fonestring40opcionalTelefone de entrega
retorno.pedido.endereco_entrega.nome_destinatariostring60opcionalNome do destinatário da entrega
retorno.pedido.itens[ ]listobrigatórioLista de itens do pedido
retorno.pedido.itens[ ].itemobjectobrigatórioElemento utilizado para representar um item do pedido
retorno.pedido.itens[ ].item.id_produtoint-opcionalNúmero de identificação do produto no Tiny
retorno.pedido.itens[ ].item.codigostring20opcionalCódigo do Produto
retorno.pedido.itens[ ].item.descricaostring120obrigatórioDescrição do Produto
retorno.pedido.itens[ ].item.unidadestring3obrigatórioUnidade do produto
retorno.pedido.itens[ ].item.quantidade (5)decimal- obrigatórioQuantidade do produto
retorno.pedido.itens[ ].item.valor_unitario (5)decimal- obrigatórioValor unitário do produto
retorno.pedido.condicao_pagamentostring30opcionalDescrição da condição de pagamento
retorno.pedido.forma_pagamentostring30obrigatórioCódigo conforme tabela de Formas de pagamento
retorno.pedido.meio_pagamentostring100opcionalDescrição do meio de pagamento
retorno.pedido.parcelas[ ]listopcionalLista de parcelas do pedido
retorno.pedido.parcelas[ ].parcelaobjectopcionalElemento utilizado para representar uma parcela do pedido
retorno.pedido.parcelas[ ].parcela.diasint20opcionalDias de Vencimento da Parcela
retorno.pedido.parcelas[ ].parcela.data (4)date10opcionalData de Vencimento da Parcela
retorno.pedido.parcelas[ ].parcela.valor (5)decimal- opcionalValor da parcela
retorno.pedido.parcelas[ ].parcela.obsstring100opcionalObservação da parcela
retorno.pedido.parcelas[ ].parcela.forma_pagamentostring30obrigatórioCódigo conforme tabela de Formas de pagamento
retorno.pedido.parcelas[ ].parcela.meio_pagamentostring100opcionalDescrição do meio de pagamento
retorno.pedido.nome_transportadorstring30opcionalNome do transportador
retorno.pedido.frete_por_contastring1opcional"R"-Remetente, "D"-Destinatário
retorno.pedido.forma_frete string30opcionalForma de frete de acordo com o cadastro no Tiny
retorno.pedido.valor_frete (5)decimal- opcionalValor do frete do pedido
retorno.pedido.valor_desconto (5)decimal- opcionalValor do desconto do pedido
retorno.pedido.total_produtos (5)decimal- opcionalValor total dos produtos
retorno.pedido.total_pedido (5)decimal- opcionalValor total do pedido
retorno.pedido.situacao string15opcionalSituação do pedido conforme tabela de Situações dos Pedidos
retorno.pedido.numero_ordem_comprastring10opcionalNúmero de ordem de compra
retorno.pedido.id_vendedorint-opcionalNúmero de identificação do Vendedor associado ao pedido.
retorno.pedido.nome_vendedorstring50opcionalNome do Vendedor associado ao pedido.
retorno.pedido.obsstring100opcionalObservação do pedido
retorno.pedido.codigo_rastreamentostring20opcionalCódigo de rastreamento do pedido
retorno.pedido.url_rastreamentostring120opcionalURL de rastreamento do pedido
retorno.pedido.id_nota_fiscalint-opcionalIdentificador da nota fiscal referenciada pela venda

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Estes campos devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(5) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".


$url = 'https://api.tiny.com.br/api2/pedido.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$formato = 'XML';
$data = "token=$token&id=$id&formato='$formato'";

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("obterPedidoService", array('token' => 'xxxxx','id'=>'xxxxx','formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}
<?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>
  <codigo_erro>21</codigo_erro>
  <erros>
    <erro>A consulta retornou mais registros que o permitido</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <pedido>
    <id>123456</id>
    <numero>123</numero>
    <numero_ecommerce>12</numero_ecommerce>
    <data_pedido>01/01/2012</data_pedido>
    <data_prevista>10/01/2012</data_prevista>
    <cliente>
      <codigo>1235</codigo>
      <nome>Contato Teste 2</nome>
      <nome_fantasia>Fantasia Contato Teste 2</nome_fantasia>
      <tipo_pessoa>F</tipo_pessoa>
      <cpf_cnpj>22755777850</cpf_cnpj>
      <ie/>
      <rg>1234567890</rg>
      <endereco>Rua Teste</endereco>
      <numero>123</numero>
      <complemento>sala 2</complemento>
      <bairro>Teste</bairro>
      <cep>95700000</cep>
      <cidade>Bento Gonçalves</cidade>
      <uf>RS</uf>
      <fone>5430553808</fone>
    </cliente>
    <itens>
      <item>
        <codigo>1234</codigo>
        <descricao>Produto Teste 1</descricao>
        <unidade>UN</unidade>
        <quantidade>2</quantidade>
        <valor_unitario>50.25</valor_unitario>
      </item>
      <item>
        <codigo>1235</codigo>
        <descricao>Produto Teste 2</descricao>
        <unidade>UN</unidade>
        <quantidade>4</quantidade>
        <valor_unitario>15.25</valor_unitario>
      </item>
    </itens>
    <condicao_pagamento>30 60 90</condicao_pagamento>
    <forma_pagamento>crediario</forma_pagamento>
    <parcelas>
      <parcela>
        <dias>30</dias>
        <data>29/11/2012</data>
        <valor>53.84</valor>
        <obs>Obs Parcela 1</obs>
        <forma_pagamento>crediario</forma_pagamento>
      </parcela>
      <parcela>
        <dias>60</dias>
        <data>29/12/2012</data>
        <valor>53.83</valor>
        <obs>Obs Parcela 2</obs>
        <forma_pagamento>crediario</forma_pagamento>
      </parcela>
      <parcela>
        <dias>90</dias>
        <data>27/01/2013</data>
        <valor>53.83</valor>
        <obs>Obs Parcela 3</obs>
        <forma_pagamento>crediario</forma_pagamento>
      </parcela>
    </parcelas>
    <nome_transportador>transportador teste</nome_transportador>
    <frete_por_conta>E</frete_por_conta>
    <valor_frete>35.00</valor_frete>
    <valor_desconto>35.00</valor_desconto>
    <total_produtos>161.50</total_produtos>
    <total_pedido>161.50</total_pedido>
    <situacao>Atendido</situacao>
    <numero_ordem_compra>123</numero_ordem_compra>
    <id_vendedor/>
    <nome_vendedor/>
    <obs>Observação Teste</obs>
  </pedido>
</retorno>