@jayabahu/purplship

Multi-carriers Shipping API Node library (Canada Post, DHL, FedEx, UPS, Purolator and more)

Usage no npm install needed!

<script type="module">
  import jayabahuPurplship from 'https://cdn.skypack.dev/@jayabahu/purplship';
</script>

README

Purplship Node.js Library

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

Visit 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');
const purplship = new Purplship('API_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 = new Purplship('API_KEY', 'https://instance.purplship.api');

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

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

Documentation for Models

Author

Purplship Team | hello@purplship.com | purplship.com Daniel K| danielk.developer@gmail.com | danielk.xyz