Você está usando um navegador que não é suportado pelo Tiny. Saiba mais

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)
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.data_faturamento (4)date10opcionalData de faturamento do pedido
retorno.pedido.data_envio (4)date10opcionalData de envio do pedido
retorno.pedido.data_entrega (4)date10opcionalData de entrega 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_fantasiastring60opcionalNome 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.endereco_entrega.iestring18opcionalInscrição estadual de 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.itens[ ].item.info_adicionalstring- opcionalInformação adicional do item no pedido de venda
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.marcadores[ ]listopcionalLista de marcadores do pedido
retorno.pedido.marcadores[ ].marcadorobjectopcionalElemento utilizado para representar um marcador do pedido
retorno.pedido.marcadores[ ].marcador.idint-opcionalIdentificação do marcador no Tiny
retorno.pedido.marcadores[ ].marcador.descricaostring50opcionalDescrição do marcador
retorno.pedido.marcadores[ ].marcador.corstring-opcionalHexadecimal da cor do marcador
retorno.pedido.nome_transportadorstring30opcionalNome do transportador
retorno.pedido.frete_por_contastring1opcionalR - Contratação do Frete por conta do Remetente (CIF), D - Contratação do Frete por conta do Destinatário (FOB), T - Contratação do Frete por conta de Terceiros, 3 - Transporte Próprio por conta do Remetente, 4 - Transporte Próprio por conta do Destinatário, S - Sem Ocorrência de Transporte
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.outras_despesas decimal- opcionalOutras despesas 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.obs_internastring100opcionalObservação interna 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
retorno.pedido.depositostring-opcionalNome do depósito vinculado pela venda
retorno.pedido.ecommerceobjectopcionalE-commerce
retorno.pedido.forma_enviostring30opcionalForma de envio, conforme Tabela de forma de envio
retorno.pedido.ecommerce.idint-opcionalIdentificador do e-commerce no Tiny
retorno.pedido.ecommerce.numeroPedidoEcommercestring-opcionalNúmero do pedido no e-commerce
retorno.pedido.ecommerce.numeroPedidoCanalVendastring-opcionalNúmero do pedido no canal de venda
retorno.pedido.ecommerce.nomeEcommercestring-opcionalNome do e-commerce
retorno.pedido.ecommerce.canalVendastring-opcionalDescrição do canal de venda vinculado ao e-commerce
retorno.pedido.intermediadorobjectopcionalIntermediador
retorno.pedido.intermediador.nomestring60obrigatórioNome no intermediador
retorno.pedido.intermediador.cnpjstring18obrigatórioCNPJ do intermediador
retorno.pedido.intermediador.cnpjPagamentostring18opcionalCNPJ da instituição de pagamento do intermediador
retorno.pedido.id_natureza_operacaostring-opcionalIdentificador da natureza de operação

(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 = 'JSON';
$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;
}