Purplship Node.js Library

Purplship is a Multi-carrier Shipping API that simplifies the integration of logistic carrier services.

Visit next.purplship.com to deploy your private cloud multi-carrier shipping API.

Documentation

See the full Node API docs.

Installation

Install using npm or yarn

npm i purplship
# or 
yarn add purplship

Usage

The package needs to be configured with your account's API key, which is available in the Purplship Dashboard.

const purplship = require('purplship')('key_...', 'https://instance.purplship.api');

purplship.carriers.list({})
    .then(carriers => console.log(carriers))
    .catch(error => console.error(error));

Or using ES modules and async/await:

import Purplship from 'purplship';
const purplship = Purplship('key_...', 'https://instance.purplship.api');

(async () => {
  const carriers = await purplship.carriers.list({});

  console.log(carriers);
})();

Author

Team purplship | [email protected] | purplship.com Daniel K | [email protected] | danielk.xyz