# iupick

> iupick API wrapper

Latest version **1.0.1** (published 2017-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install iupick
pnpm add iupick
yarn add iupick
bun add iupick
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-11-03 |
| First published | 2017-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | iupick |
| Maintainers | vanclief |
| Keywords | iupick, shipping, methods, api |

## Links

- npm: https://www.npmjs.com/package/iupick
- Repository: https://github.com/iupickmx/iupick-node
- Homepage: https://github.com/iupickmx/iupick-node#readme
- Issues: https://github.com/iupickmx/iupick-node/issues
- npm.io page: https://npm.io/package/iupick

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.83.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2

## Recent versions

- 1.0.1 (latest) — 2017-11-03
- 1.0.0 — 2017-10-20

## README

# 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
info@iupick.com for more information.

## Installation

Install the package with:

```
npm install iupick --save
```

## Usage

Import the library and instantiate a new iupick object.

``` js
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.

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

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

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

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

``` js
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 though our Waybill API, you will need to create a confirmation token so our points are able to receive your
package.

``` js
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 with our available carriers,
and tracking your shipment.

The waybill generation occurs on three steps:

### Step 1

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

``` js
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.

     ``` js
     var shipperAddress = iupick.createAddress(
         city = 'Querétaro',
         lineOne = 'Epigmenio Gonzáles 500',
         postalCode = 76130,
         lineTwo = '',
         neighborhood = 'Momma'
         );

     var shipperContact = iupick.createPerson(
         personName = 'Tony Stark',
         phoneNumber = '555555555',
         emailAddress = 'tony@fakemail.com',
         title = 'CEO',
         companyName = 'Stark Industries',
         phoneExtension = '123'
         )

     var recipientContact = iupick.createPerson(
         personName='Steve Rogers',
         phoneNumber='555555555',
         emailAddress='steve@fakemail.com',
         title='Agent',
         companyName='SHIELD',
         phoneExtension='123'
         )
     ```

     ```js
     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
});

```

### Step 3.

Generate your waybill with your confirmation token.

``` js
iupick.shipment.generateWaybill(
    confirmationToken,
    function(waybill) {
    waybill // the created waybill link, tracking number and carrier
    });

```

### Tracking your shipment

In order to track a shipment send the carrier and the tracking number.

``` js
iupick.shipment.track({carrier: 'Estafeta', trackingNumber: '8055241528464720099314'},
    function(status){
    status; // the tracking status
    });
```

---
_Source: https://npm.io/package/iupick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._