sdk-intelipost v1.1.0

SDK NODE - Intelipost API V1

Introdução

SDK para auxiliar no consumo de alguns endpoints existentes na API V1, conforme documentação.

Instalação

Instalar utilizando o NPM. Para instalar o SDK, execute o seguinte comando no diretorio do seu projeto node.

npm i sdk-intelipost

Dependências

• axios ≥ (0.18)
• chai (≥ 7.0.1)
• mocha (≥5.2)
• random-number(≥ 0.0.9 )

Uso

Para utilizar o SDK é necessário:

1. Importar o modulo da intelipost e executar o método desejado, todo método requer como parâmetro um header que tem os seguintes atributos:

• Api-Key - Chave de autenticação fornecida pela Intelipost
• Platform - Plataforma origem da requisição
• Platform-version - A versão atual da plataforma
• Plugin - Nome do conector utilizado
• Plugin-version - Versão do conector utilizado
• Logging - Flag que diz se deverão ser gravados logs
• LogPath - Se forem gravados logs, aqui deve ser informado o diretório

e segue o seguinte formato:

{
    "Api-Key":"digite sua api",
    "platform": "my-ecommerce",
    "platformVersion": "v1.0",
    "pluginVersion":"v1.1.2"
}

2. Grande maioria dos métodos POST requerem um Request Body acesse a documentação para saber qual modelo de Request Body deve ser enviado em sua requisição.

Endpoints Disponíveis

• AutoComplete - GET ( /cep_location/address_complete/{cep} )

const intelipost = require('sdk-intelipost');
intelipost.location.autoComplete("cep desejado",header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {

});

• ChangeDeliveryMethod - POST ( /shipment_order/change_delivery_method )

Exemplo:

const intelipost = require('sdk-intelipost');
intelipost.order.changeDeliveryMethod(RequestBody,header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {
    
});

• GetLabel - GET ( /shipment_order/get_label/{order_number}/{shipment_order_volume_number} )

const intelipost = require('sdk-intelipost');
intelipost.order.getLabel(pedido_envio,numero_volume,header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {

});

• GetShipmentOrder - GET ( /shipment_order/{order_number} )

const intelipost = require('sdk-intelipost');
    
intelipost.order.getShipmentOrder(pedido_de_envio,header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {

});

• Info - GET ( /info )

const intelipost = require('sdk-intelipost');
intelipost.info.getInfo(header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {
    
});
    

• Quote - POST ( /quote )

const intelipost = require('sdk-intelipost');
intelipost.quote.quote(RequestBody,header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {

});

• QuoteByProduct - POST ( /quote_by_product )

    
const intelipost = require('sdk-intelipost');
intelipost.quote.quoteByProduct(RequestBody,header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {
    
});
    

• ReadyForShipmentWithDate - POST ( /shipment_order/multi/ready_for_shipment/with_date )

const intelipost = require('sdk-intelipost');
 
var orders = [
  {
    "order_number": "PEDIDO0012",
    "event_date": "2016-06-29T14:15:11"
  },
  {
    "order_number": "PEDIDO0013",
    "event_date": "2016-06-29T14:15:11"
  }
 ]

intelipost.order.readyForShipmentWithDate(header,orders).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {
    
});

• ShipmentOrder - POST ( /shipment_order )

const intelipost = require('sdk-intelipost');
intelipost.order.shipmentOrder(RequestBody,header).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {

});

• ShippedWithDate - POST ( /shipment_order/multi/shipped/with_date )

const intelipost = require('sdk-intelipost');
var orders = [
{
    "order_number": "PEDIDO0012",
    "event_date": "2016-06-29T14:15:11"
},
{
    "order_number": "PEDIDO0013",
    "event_date": "2016-06-29T14:15:11"
 }
]

intelipost.order.shippedWithDate(header,orders).then((result) => {
    console.log(JSON.stringify(result.data));
}).catch((err) => {
    
});

Last Release

Release 2.1.0:

• New Change Delivery Method;

See all release notes