Alterar Pedido API 2.0
destinado a fazer alteração de alguns dados de Pedidos.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | - | obrigatório | Id do pedido de venda a ser alterado |
Conteúdo do body
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
dados_pedido (1) | object | obrigatório | Dados do pedido conforme layout |
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
data_prevista (1) | date | 10 | opcional | Data de previsão do pedido |
data_envio (2) | date | 19 | opcional | Data de envio do pedido |
obs | string | 100 | opcional | Observação do pedido |
obs_interna | string | 100 | opcional | Observação interna do pedido |
parcelas[ ] | list | opcional | Lista de parcelas do pedido | |
parcelas[ ].dias | int | 20 | opcional | Dias de Vencimento da Parcela |
parcelas[ ].data (1) | date | 10 | opcional | Data de Vencimento da Parcela |
parcelas[ ].valor (3) | decimal | - | opcional | Valor da parcela |
parcelas[ ].obs | string | 100 | opcional | Observação da parcela |
parcelas[ ].destino | string | 50 | opcional | Destino da parcela (Ex:Caixa, Contas a Receber), por padrão as parcelas vão para contas a receber |
parcelas[ ].forma_pagamento | string | 30 | opcional | Código da forma de pagamento conforme Tabela de Formas de Pagamento |
parcelas[ ].meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
(1) - Estes campos dever ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(2) - Estes campos dever ser informado no formato dd/mm/yyyy hh:mm:ss, exemplo "01/01/2012 08:20:10".
(3) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
Retorno do serviço
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 (1) | 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 (3) | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.erros[ ].campo (3) | string | - | condicional | Nome do campo do body com problema(s) de validação |
(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
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/pedido.alterar.php';
$token = 'coloque aqui a sua chave da api';
$id = '12345';
$data = "token=$token&id=$id";
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;
}