node-shipping-purolator v1.0.1

Node Shipping Purolator

Install

npm i node-shipping-purolator

Usage

Init

const PurolatorAPI = require('node-shipping-purolator');

const purolator = new PurolatorAPI({
  environment: 'production', // or development
  debug: true,
  key: '[key]',
  password: '[password]',
  account: '[account number]'
});

Documents

See params here

purolator.getDocuments(params, cb);

purolator.getShipmentManifestDocument(params, cb);

Estimate

See params here

purolator.getQuickEstimate(params, cb);

purolator.getFullEstimate(params, cb);

Pickup

See params here

purolator.schedulePickup(params, cb);

purolator.voidPickup(params, cb);

purolator.validatePickup(params, cb);

Return Shipment

See params here

purolator.createReturnShipment(params, cb);

purolator.validateReturnShipment(params, cb);

Services

See params here

purolator.getServicesOptions(params, cb);

purolator.getServicesRules(params, cb);

purolator.validateCityPostalCodeZip(params, cb);

Shipment

See params here

purolator.consolidate(params, cb);

purolator.voidShipment(params, cb);

purolator.validateShipment(params, cb);

purolator.createShipment(params, cb);

Tracking

See params here

purolator.trackPackagesByPin(params, cb);

purolator.trackPackagesByRef(params, cb);

purolator.getDeliveryDetails(params, cb);

Links

Official Purolator API documentation

TO DO

• ModifyPickUp
• GetPickUpHistory
• GetLocationsByAddress
• GetLocationsByCoordinates
• GetLocationsByCity
• GetLocationsByPointOfInterest
• GetLocationsByPostalCode