Incluir Pedido API 2.0

destinado a fazer inclusão de Pedidos.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
pedido ⁽¹⁾	-	obrigatório	Dados do pedido conforme layout
formato	string	obrigatório	Formato do retorno (json)

(1) - Layout do parâmetro pedido

Elemento	Tipo	Tamanho	Ocorrência	Descrição
pedido	object	-	obrigatório	Elemento utilizado para representar um Pedido.
pedido.data_pedido ⁽¹⁾	date	10	opcional	Data do pedido
pedido.data_prevista ⁽¹⁾	date	10	opcional	Data de previsão do pedido
pedido.id_lista_preco	int	-	opcional	Número de identificação da lista de preços no Tiny
pedido.cliente	object		obrigatório	Elemento utilizado para representar o cliente
pedido.cliente.codigo ⁽⁵⁾	string	30	opcional	Código do cliente
pedido.cliente.nome ⁽⁵⁾	string	30	obrigatório	Nome do cliente
pedido.cliente.nome_fantasia	string	60	opcional	Nome fantasia do cliente
pedido.cliente.tipo_pessoa	string	1	opcional	Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
pedido.cliente.cpf_cnpj ⁽⁵⁾	string	18	opcional	CPF ou CNPJ do cliente
pedido.cliente.ie	string	18	opcional	Inscrição estadual do cliente
pedido.cliente.rg	string	10	opcional	RG do cliente
pedido.cliente.endereco	string	50	opcional	Endereço do cliente
pedido.cliente.numero	string	10	opcional	Número do endereço do cliente
pedido.cliente.complemento	string	50	opcional	Complemento do endereço do cliente
pedido.cliente.bairro	string	30	opcional	Bairro do cliente
pedido.cliente.cep	string	10	opcional	Cep do cliente
pedido.cliente.cidade	string	30	opcional	Nome da cidade do cliente conforme a Tabela de Cidades
pedido.cliente.uf	string	30	opcional	UF do cliente
pedido.cliente.pais	string	50	opcional	Nome do País do cliente conforme Tabela de Países
pedido.cliente.fone	string	40	opcional	Telefone do cliente
pedido.cliente.email	string	50	opcional	E-mail do cliente
pedido.cliente.atualizar_cliente ⁽⁶⁾	string	1	opcional	("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S"
pedido.endereco_entrega	object		opcional	Elemento utilizado para representar o endereço de entrega, caso seja diferente do endereço do cliente
pedido.endereco_entrega.tipo_pessoa	string	1	opcional	Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
pedido.endereco_entrega.cpf_cnpj	string	18	opcional	CPF ou CNPJ de entrega
pedido.endereco_entrega.endereco	string	50	opcional	Endereço de entrega
pedido.endereco_entrega.numero	string	10	opcional	Número do endereço de entrega
pedido.endereco_entrega.complemento	string	50	opcional	Complemento do endereço de entrega
pedido.endereco_entrega.bairro	string	30	opcional	Bairro de entrega
pedido.endereco_entrega.cep	string	10	opcional	Cep de entrega
pedido.endereco_entrega.cidade	string	30	opcional	Nome da cidade de entrega conforme a Tabela de Cidades
pedido.endereco_entrega.uf	string	30	opcional	UF de entrega
pedido.endereco_entrega.fone	string	40	opcional	Telefone de entrega
pedido.endereco_entrega.nome_destinatario	string	60	opcional	Nome do destinatário da entrega
pedido.endereco_entrega.ie	string	18	opcional	Inscrição estadual de entrega
pedido.itens[ ]	list		obrigatório	Lista de itens do pedido
pedido.itens[ ].item	object		obrigatório	Elemento utilizado para representar um item do pedido
pedido.itens[ ].item.id_produto ⁽⁷⁾⁽⁴⁾	int	-	opcional	Identificador do produto no Tiny
pedido.itens[ ].item.codigo ^{(7) (4)}	string	60	opcional	Código do Produto
pedido.itens[ ].item.descricao ⁽⁷⁾	string	120	obrigatório	Descrição do Produto
pedido.itens[ ].item.unidade	string	3	obrigatório	Unidade do produto
pedido.itens[ ].item.quantidade ⁽²⁾	decimal	-	obrigatório	Quantidade do produto
pedido.itens[ ].item.valor_unitario ⁽²⁾	decimal	-	obrigatório	Valor unitário do produto
pedido.itens[ ].item.aliquota_comissao ⁽²⁾ ⁽³⁾	decimal	-	opcional	Valor da aliquota de comissão do item
pedido.itens[ ].item.informacao_adicional	string	-	opcional	Informação adicional do item no pedido de venda
pedido.marcadores[ ]	list	-	opcional	Elemento raiz utilizado para representar um conjunto Marcadores.
pedido.marcadores[ ].marcador	object	-	opcional	Elemento utilizado para representar um Marcador.
pedido.marcadores[ ].marcador.id ⁽¹²⁾	int	-	opcional	Número de identificação de um Marcador no Tiny.
pedido.marcadores[ ].marcador.descricao ^{(12) (13)}	string	50	opcional	Descrição do marcador.
pedido.forma_pagamento	string	30	opcional	Código da forma de pagamento conforme Tabela de Formas de Pagamento
pedido.meio_pagamento	string	100	opcional	Descrição do meio de pagamento
pedido.parcelas[ ]	list		opcional	Lista de parcelas do pedido
pedido.parcelas[ ].parcela	object		opcional	Elemento utilizado para representar uma parcela do pedido
pedido.parcelas[ ].parcela.dias	int	20	opcional	Dias de Vencimento da Parcela
pedido.parcelas[ ].parcela.data ⁽¹⁾	date	10	opcional	Data de Vencimento da Parcela
pedido.parcelas[ ].parcela.valor ⁽²⁾	decimal	-	opcional	Valor da parcela
pedido.parcelas[ ].parcela.obs	string	100	opcional	Observação da parcela
pedido.parcelas[ ].parcela.destino	string	50	opcional	Destino da parcela (Ex:Caixa, Contas a Receber), por padrão as parcelas vão para contas a receber
pedido.parcelas[ ].parcela.forma_pagamento	string	30	opcional	Código da forma de pagamento conforme Tabela de Formas de Pagamento
pedido.parcelas[ ].parcela.meio_pagamento	string	100	opcional	Descrição do meio de pagamento
pedido.nome_transportador	string	100	opcional	Nome do transportador
pedido.frete_por_conta	string	1	opcional	"R"-Remetente, "D"-Destinatário
pedido.valor_frete ⁽²⁾	decimal	-	opcional	Valor do frete do pedido
pedido.forma_envio	string	30	opcional	Forma de envio, conforme Tabela de forma de envio
pedido.forma_frete	string	30	opcional	Forma de frete de acordo com o cadastro no Tiny
pedido.valor_desconto ⁽²⁾	decimal	-	opcional	Valor do desconto do pedido
pedido.outras_despesas	decimal	-	opcional	Outras despesas do pedido
pedido.numero_ordem_compra	string	10	opcional	Número de ordem de compra
pedido.id_vendedor ⁽⁸⁾	int	-	opcional	Número de identificação do Vendedor cadastrado no Tiny
pedido.nome_vendedor ⁽⁸⁾ ⁽⁹⁾	string	50	opcional	Nome do Vendedor cadastrado no Tiny
pedido.obs	string	100	opcional	Observação do pedido
pedido.obs_internas	string	100	opcional	Observação interna do pedido
pedido.situacao	string	15	opcional	Situação do pedido conforme tabela de Situações dos Pedidos
pedido.numero_pedido_ecommerce	string	50	opcional	Número de identificação do pedido no e-commerce (ou no seu sistema)
pedido.id_ecommerce ⁽¹⁰⁾	int	-	opcional	Número de identificação do e-commerce cadastrado no Tiny
pedido.ecommerce ⁽¹¹⁾	string	50	opcional	Plataforma que está enviando o pedido
pedido.intermediador ⁽¹⁴⁾	object		opcional	Intermediador
pedido.intermediador.nome	string	60	obrigatório	Nome no intermediador
pedido.intermediador.cnpj	string	18	obrigatório	CNPJ do intermediador
pedido.intermediador.cnpjPagamento	string	18	opcional	CNPJ da instituição de pagamento do intermediador
pedido.id_natureza_operacao	string	-	opcional	Identificador da natureza de operação
pedido.nome_natureza_operacao	string	-	opcional	Nome da natureza de operação
pedido.nome_deposito	string	-	opcional	Nome do depósito
pedido.pagamentos_integrados[]	list	[0..n]	opcional	Lista de pagamentos integrados do pedido
pedido.pagamentos_integrados[].pagamento_integrado	object	-	obrigatório	Elemento utilizado para representar o pagamento integrado
pedido.pagamentos_integrados[].pagamento_integrado.tipo_pagamento	int	-	obrigatório	Código da forma de pagamento conforme Tabela de Meios de pagamento de NFe
pedido.pagamentos_integrados[].pagamento_integrado.valor	decimal	-	obrigatório	Valor do pagamento
pedido.pagamentos_integrados[].pagamento_integrado.cnpj_intermediador	string	14	obrigatório	CNPJ do Intermediador
pedido.pagamentos_integrados[].pagamento_integrado.codigo_autorizacao	string	-	obrigatório	Código de autorização da transação
pedido.pagamentos_integrados[].pagamento_integrado.codigo_bandeira	int	-	obrigatório	Bandeira da operadora de cartão.

(1) - Estes campos dever ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(2) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(3) - Caso seja informado um valor diferente da aliquota cadastrada para o vendedor a aliquota do vendedor será desconsiderada. Caso seja informado o valor zero a aliquota deste item será zero.
(4) - Este campo é utilizado somente para pesquisar o produto.
(5) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja os demais campos são carregados do cadastro.
(6) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(7) - Estes campos são utilizados para pesquisar se o produto está cadastrado, caso esteja os demais campos são carregados do cadastro.
(8) - Caso o vendedor não seja localizado será apresentado um erro de validação.
(9) - Este campo será desconsiderado caso haja valor no campo id_vendedor.
(10) - Para esse campo ser considerado, o campo numero_pedido_ecommerce deve ser enviado.
(11) - Este campo será desconsiderado caso haja valor no campo id_ecommerce.
(12) - Ao menos um desses parâmetros deve ser informado.
(13) - Se a descrição informada não existir, será criado um novo marcador.
(14) - Será realizada uma busca pelo nome e cnpj, em conjunto. Caso não existir, o intermediador será criado. Caso o intermediador for informado, o nome e o cnpj são obrigatórios.

Elemento	Tipo	Tamanho	Ocorrência	Descrição
retorno	object	-	obrigatório	Elemento 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	-	obrigatório	Conforme tabela "Códigos de erro"
retorno.erros[ ] ^{(1) (3)}	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.registros[ ] ⁽²⁾	list	-	condicional	Lista de resultados da pesquisa
retorno.registros[ ].registro ⁽²⁾	object	-	condicional	Elemento utilizado para representar um pedido.
retorno.registros[ ].registro.sequencia	int	-	condicional	Número sequencial utilizado para identificar cada pedido.
retorno.registros[ ].registro.status	string	-	condicional	Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erro	int	-	condicional	Conforme tabela "Códigos de erro"
retorno.registros[ ].registro.erros[ ] ⁽³⁾	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.registros[ ].registro.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.registros[ ].registro.id	int	-	condicional	Número de identificação do Pedido no Tiny
retorno.registros[ ].registro.numero	int	-	condicional	Número do Pedido no Tiny

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.

Exemplos do parâmetro pedido em JSON

Exemplos da chamada em REST


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

Incluir Pedido API 2.0

Parâmetros do serviço

(1) - Layout do parâmetro pedido

Retorno do serviço

Exemplos do parâmetro pedido

Exemplos do parâmetro pedido em JSON

Exemplos de chamada da API

Exemplos da chamada em REST

Exemplos de retorno da API

Exemplos do retorno do serviço em JSON

Atendimento

Localização