Solicitação

Solicitação HTTP

POST 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 é:
  • encomenda - adiciona a encomenda conforme os parâmetros de solicitação da API.
codigo string
Código de identificação da encomenda.
Informação fornecida pelos Correios.

Limite: 20 caracteres

Exemplo: SS123456789BR.
tipo string
Tipo de encomenda.

Valores válidos:
  • compras - referente as suas compras.
  • vendas - referente as suas vendas.
  • outros - encomendas variadas.
Parâmetros obrigatórios se o parâmetro tipo for vendas
notificar_cliente unsigned integer
Informa se o cliente será notificado.

Limite: 1 caracter

Valores válidos:
  • 1 - notifica.
  • 0 - não notifica.
Observação: retorna 0 se o tipo da encomenda for diferente de vendas
Parâmetros obrigatórios se o parâmetro notificar_cliente for 1
notificar_cliente_email string
Informa o email de notificação do cliente.

Limite: 50 caracteres

Observação: adicionar valor vazio se notificar_cliente for 0.
notificar_cliente_email_assunto string
Informa o assunto do email de notificação do cliente.

Limite: 100 caracteres

Observação: adicionar valor vazio se notificar_cliente for 0.
Parâmetros opcionais
descricao string
Descrição que identifica a encomenda.

Limite: 255 caracteres

Exemplo: AliExpress - GoPro

Resposta

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

{
  "status": "ok"
}

Propriedades

A tabela a seguir define as propriedades que aparecem nesse recurso:

Propriedade
status string
Se a encomenda foi adicionada com sucesso o valor do status será ok.

Exemplo

O exemplo de código a seguir faz a solicitação que adiciona uma encomenda.

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',
  'descricao' => 'AliExpress - GoPro',
  'tipo' => 'vendas',
  'notificar_cliente' => '1',
  'notificar_cliente_email' => 'email@cliente.com.br',
  'notificar_cliente_email_assunto' => 'Movimentação da Encomenda - NF nº 123'
);

// faz a solicitação para adicionar uma 'encomenda' conforme os parâmetros fornecidos.
$responseJson = $api->post('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',
  'descricao' : 'AliExpress - GoPro',
  'tipo' : 'vendas',
  'notificar_cliente' : '1',
  'notificar_cliente_email' : 'email@cliente.com.br',
  'notificar_cliente_email_assunto' : 'Movimentação da Encomenda - NF nº 123'
};

// faz a solicitação para adicionar uma 'encomenda' conforme os parâmetros fornecidos.
api.post('encomenda', parametros, function (data) {
   console.log(data);
});
</script>
            
curl -X POST "http://www.minhasencomendas.com.br/api/v1/" 
     -d "token=8deeb4b36df01f5307fc&model=encomenda&codigo=SS123456789BR&descricao=AliExpress - GoPro&tipo=vendas&notificar_cliente=1&notificar_cliente_email=email@cliente.com.br&notificar_cliente_email_assunto=Movimentação da Encomenda - NF nº 123"
            

Comentários