diego-d5000 / iupick-node

Node library for the iupick API.

iupick-node

The iupick Node library wraps the iupick API to facilitate access from applications written in server-side JavaScript.

Keep in mind that this package requires iupick secret keys, contact [e-mail] for more information.

Installation

Install the package with:

npm install iupick --save

Usage

Import the library and instantiate a new iupick object.

var Iupick = require('../lib/iupick');

const secretToken = 'sk_sandbox_4bdcd3630417c5119029859c08a7b8d9d97dda79'
const publicToken = '315cdf3ca4dd588ab8e6f7fa4b7aa433c641cadd'
const environment = 'sandbox'

iupick = new Iupick(secretToken, publicToken, environment);

The iupick Node library has multiple resources with methods that call the API and return a callback.

Methods require either your Public or your Secret token, never expose your secret token.

Methods that require your secret_token should never be done from the front-end. Since this methods deal with sensitive information.

Waypoints

The Waypoints resource allows you to interact with all the delivery points from our network that are available to your account.

To pull the full information for a single waypoint. Use getWaypointInformation It requires the waypoint unique id.

iupick.waypoint.getWaypointInformation(20, function(waypoint) {
    waypoint; // information of the waypoint
    });

To get a list of all the coordinates of available waypoints, use getWaypointsLite.

iupick.waypoint.getWaypointsLite(function(waypoints) {
    waypoints; // list of waypoints
    });

You can get all the waypoints close to a Postal Code with getPostalCodeWaypoints.

iupick.waypoint.getPostalCodeWaypoints(95710, function(waypoints) {
    waypoints; // list of waypoints by CP
    });

External Shipments

If you want to generate a shipment to one of iupick delivery points, but not through our Waybill API, you will need to create a confirmation token so our points are able to receive your package.

iupick.shipment.confirmShipmentWaypoint({waypoint: 486, orderId: "ORDER666"},
    function(confirmation){
    conformation; // A confirmation token
    });

The waypoint argument receives the id of the point you want to ship to, the orderId is your own generated order id.

Shipments with iupick

The iupick API allows the generation of waybills and tracking with our available carriers.

The waybill generation occurs on three steps:

Step 1

Create a shipment on the iupick platform and receive a shipment token.

iupick.shipment.create({length: 8, width: 8, height: 8, weight: 1.1},
    function(shipmentToken) {
    shipmentToken; //the created shipment token
    });

Step 2

Fill the rest of the information required to generate a waybill, and receive a confirmation token.

You can send a shipment either to an arbitrary direction or to one of our waypoints; just replace the waypoint_id attribute for a recipient address.

var shipperAddress = iupick.createAddress(
    city = 'Querétaro',
    lineOne = 'Epigmenio Gonzáles 500',
    postalCode = {
        state:
        {
            name: "Querétaro",
            code: "QT"
        },
        code: "05200",
    },
    lineTwo = '',
    neighborhood = 'Momma'
    );

var shipperContact = iupick.createPerson(
    personName = 'Tony Stark',
    phoneNumber = '555555555',
    emailAddress = '[e-mail]',
    title = 'CEO',
    companyName = 'Stark Industries',
    phoneExtension = '123'
    )

var recipientContact = iupick.createPerson(
    personName='Steve Rogers',
    phoneNumber='555555555',
    emailAddress='[e-mail]',
    title='Agent',
    companyName='SHIELD',
    phoneExtension='123'
    )

You can use our helper methods to create the required objects.

iupick.shipment.addInformation({
shipmentToken: shipmentToken,
waypointId: 486,
shipperAddress: shipperAddress,
shipperContact: shipperContact,
recipientContact: recipientContact,
thirdPartyReference: 'I am a shipment'},
function(confirmationToken) {
confirmationToken; // the created confirmation token
});