Solicitação

Solicitação HTTP

GET http://www.minhasencomendas.com.br/api/v1

Parâmetros

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:
  • Para gerá-lo é necessário estar cadastro.
  • Se você já está cadastrado, basta acessar a página do token para gerá-lo.
model string
Identifica esta solicitação.

O único valor aceitável é:
  • lista - retorna uma lista de encomendas conforme os parâmetros de solicitação.
Parâmetros opcionais
palavra_chave string
Retorna a lista de encomendas conforme a palavra chave.

Observação: a palavra chave pode ser o código ou a descrição da encomenda.
pagina unsigned integer
Número da página que deseja acessar.

Observação: se não informado o valor padrão é 1.
por_pagina unsigned integer
Retorna o número de resultados por página.

Observação: se não informado o valor padrão é 25.
Parâmetros Opcionais (especifique exatamente um dos seguintes parâmetros)
tipo string
Tipo de encomenda.

Valores válidos:
  • compras - referente as suas compras.
  • vendas - referente as suas vendas.
  • outros - encomendas variadas.
status string
Status da encomenda.

Valores válidos:
  • pendentes - retorna as encomendas pendentes.
  • entregues - retorna as encomendas já entregues.
  • arquivados - retorna as encomendas que estão arquivadas.
ordem string
Define a ordem

Valores válidos:
  • postagem_primeiros - ordena por postagem de AZ.
  • postagem_ultimos - ordena por postagem de ZA.
  • movimentacao_primeiros - ordena por movimentação de AZ.
  • movimentacao_ultimos - ordena por movimentação de ZA.

Resposta

Se for bem sucedido, este método retorna um corpo de resposta com a seguinte estrutura:

{
  "status": "ok",
  "total": unsigned integer,
  "pagina": unsigned integer,
  "por_pagina": unsigned integer,
  "lista": [
    {
      "codigo": string,
      "descricao": string,
      "status": string,
      "status_detalhes": string,
      "data_postagem": date,
      "data_ultima_movimentacao": date,
      "dias_totais": unsigned integer,
      "dias_uteis": unsigned integer,
      "pais_origem": string,
      "pais_origem_nome": string,
      "tipo": string,
      "entregue": unsigned integer,
      "arquivado": unsigned integer,
      "url": string
    }
  ]
}

Propriedades

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.
total unsigned integer
Número total de encomendas encontradas na resposta da solicitação.

Exemplo: 42
pagina unsigned integer
Página atual dentro do resultado total.

Exemplo: 1
por_pagina unsigned integer
Quantidade de resultados que retornaram em cada página.

Exemplo: 18
lista[] array
Lista de encomendas resultado da solicitação.
lista[].codigo string
Código de identificação da encomenda.
Informação fornecida pelos Correios.

Exemplo: SS123456789BR
lista[].descricao string
Descrição que identifica a encomenda.

Exemplo: AliExpress - GoPro
lista[].status string
Status do último evento.
Informação fornecida pelos Correios.

Exemplo: Baixa de distribuição externa
lista[].status_detalhes string
Status detalhado do último evento.
Informação fornecida pelos Correios.

Exemplo: Objeto entregue ao destinatário
lista[].data_postagem date
Data da postagem.
Informação fornecida pelos Correios.

Exemplo: 05/01/2015
lista[].data_ultima_movimentacao date
Data da última movimentação.
Informação fornecida pelos Correios.

Exemplo: 04/03/2015
lista[].dias_totais unsigned integer
Período total (dias) de rastreamento.

Exemplo: 58
lista[].dias_uteis unsigned integer
Dias úteis no período total de rastreamento.

Exemplo: 42
lista[].pais_origem string
Sigla referente ao país de origem da encomenda.
Informação fornecida pelos Correios.

Exemplo: BR
lista[].pais_origem_nome string
Nome do país de origem da encomenda.
Informação fornecida pelos Correios.

Exemplo: Brasil
lista[].tipo string
Tipo de encomenda.

Valores válidos:
  • compras - referente as suas compras.
  • vendas - referente as suas vendas.
  • outros - encomendas variadas.
lista[].entregue unsigned integer
Informa se a encomenda já foi entregue.

Valores válidos:
  • 1 - entregue.
  • 0 - pendente.
lista[].arquivado unsigned integer
Informa se a encomenda está arquivada.

Valores válidos:
  • 1 - arquivada.
  • 0 - não arquivada.
lista[].url string
Retorna a url referente aos detalhes e movimentações referente a encomenda.

Exemplo

O exemplo de código a seguir faz a solicitação da lista de encomendas usando os parâmetros tipo, status, ordem, por_pagina e pagina para recuperar resultados de uma pesquisa.

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(
  'tipo' => 'compras',
  'status' => 'pendentes',
  'ordem' => 'postagem_ultimos',
  'por_pagina' => '10',
  'pagina' => '1'
);

// faz a solicitação da 'lista' de encomendas conforme seus respectivos $parametros.
$responseJson = $api->get('lista', $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 = {
  'tipo' : 'compras',
  'status' : 'pendentes',
  'ordem' : 'postagem_ultimos',
  'por_pagina' : '10',
  'pagina' : '1'
};

// faz a solicitação da 'lista' de encomendas conforme seus respectivos parametros.
api.get('lista', parametros, function (data) {
   console.log(data);
});
</script>
            
curl -X GET "http://www.minhasencomendas.com.br/api/v1/" 
     -G 
     -d "token=8deeb4b36df01f5307fc&model=lista&tipo=compras&status=pendentes&ordem=postagem_ultimos&por_pagina=10&pagina=1"
            

Comentários