Retorna os dados cadastrados que podem ser alterados de uma determinada encomenda conforme o código de identificação fornecido pelos Correios.
GET http://www.minhasencomendas.com.br/api/v1
A tabela a seguir contém a lista de parâmetros suportados por esta solicitação.
Parâmetros | |
---|---|
Parâmetros obrigatórios | |
token |
string Seu token de segurança para acessar a API de dados.Observação: |
model |
string Identifica esta solicitação. O único valor aceitável é:
|
codigo |
string Código de identificação da encomenda. Informação fornecida pelos Correios. Exemplo: SS123456789BR .
|
Se for bem sucedido, este método retorna um corpo de resposta com a seguinte estrutura:
{ "status": "ok", "encomenda": { "descricao": string, "arquivado": unsigned integer, "tipo": string, "notificacao_vendas": { "notificar": unsigned integer, "cliente_email": string, "cliente_email_assunto": string } } }
A tabela a seguir define as propriedades que aparecem nesse recurso:
Propriedade | |
---|---|
status |
string Se a resposta for bem sucedida o valor do status será ok .
|
encomenda |
object Retorna os dados da encomenda conforme o código de identificação. Informação fornecida pelos Correios. |
encomenda.descricao |
string Descrição que identifica a encomenda. Exemplo: AliExpress - GoPro
|
encomenda.arquivado |
unsigned integer Informa se a encomenda está arquivada. Valores válidos:
|
encomenda.tipo |
string Tipo de encomenda. Valores válidos:
|
encomenda.notificacao_vendas |
object Retorna os dados referente a notificação de vendas. |
encomenda.notificacao_vendas.notificar |
unsigned integer Informa se o cliente será notificado. Valores válidos:
|
encomenda.notificacao_vendas.cliente_email |
string Retorna o email de notificação do cliente. Observação: retorna vazio se notificar for 0 .
|
encomenda.notificacao_vendas.cliente_email_assunto |
string Retorna o assunto do email de notificação do cliente. Observação: retorna vazio se notificar for 0 .
|
O exemplo de código a seguir faz a solicitação que retorna os dados cadastrados que podem ser alterados de uma encomenda
usando o parâmetro codigo
para recuperar os dados cadastrados.
Este exemplo usa a biblioteca cliente PHP Minhas Encomendas.
<?php require_once 'libraries/MinhasEncomendas.php'; $token = '8dffb5b37df02f6307fd'; // obrigatório $api = new MinhasEncomendas($token); /* * O token também poderá ser declarado pela função * $api->set_token($token); */ $parametros = array( 'codigo' => 'SS123456789BR' ); // faz a solicitação da 'encomenda' conforme o código de identificação fornecido pelos Correios. $responseJson = $api->get('encomenda', $parametros); // converte o resultado JSON em ARRAY $responseArray = json_decode($responseJson); ?>
Este exemplo usa a biblioteca cliente Javascript Minhas Encomendas.
<script type="text/javascript" src="js/MinhasEncomendas.js"></script> <script> var token = '8dffb5b37df02f6307fd'; // obrigatório var api = new MinhasEncomendas(token); /* * O token também poderá ser declarado pela função * api.setToken(token); */ var parametros = { 'codigo' : 'SS123456789BR' }; // faz a solicitação da 'encomenda' conforme o código de identificação fornecido pelos Correios. api.get('encomenda', parametros, function (data) { console.log(data); }); </script>
curl -X GET "http://www.minhasencomendas.com.br/api/v1/" -G -d "token=8deeb4b36df01f5307fc&model=encomenda&codigo=SS123456789BR"