canadapost-api-alt

1.3.1 • Public • Published

Canada Post API

js-semistandard-style

Fairly straightforward wrapper for the Canada Post API. Forked from t3rminus/canada-post to add contract shipments and update dependencies.

Handles basic rating, creating shipments, and tracking.

NPM

Documentation

API Documentation is available here.

Credentials

To authenticate with canada post you need to create a developer account. Once you've done that they'll give you a username and password that are a string of numbers and letters:

  • For users of this library, put those into the new CanadaPostClient($USERNAME, $PASSWORD, $CUSTOMER_NUMBER);
  • For development use, put those in a .env file in the root of the repo (CPC_USERNAME, CPC_PASSWORD, CPC_CUSTOMER).

If you forget to put your customer number in, you'll probably get 404 errors for some endpoints.

Package Sidebar

Install

npm i canadapost-api-alt

Weekly Downloads

7

Version

1.3.1

License

MIT

Unpacked Size

47.2 kB

Total Files

9

Last publish

Collaborators

  • crowselectromusic