@easypost/api

EasyPost Node Client Library

EasyPost, the simple shipping solution. You can sign up for an account at https://easypost.com.

NOTE: This library is intended to be used in a backend Node service and not in a frontend Javascript project via the browser.

Install

npm install --save @easypost/api

NOTE: If you are using @easypost/api prior to v5 and a version of Node less than 6.9, you will need to install and include a polyfill, such as babel-polyfill, and include it in your project:

npm install --save babel-polyfill

// Require the polyfill if necessary:
require('babel-polyfill');

// Require the EasyPost library:
const EasyPost = require('@easypost/api');

You can alternatively download the various built assets from this project's releases page.

Compatibility

By default, @easypost/api (prior to v5) works with Node v6 LTS. To include for other versions of node, you can use:

• require('@easypost/api/easypost.8-lts.js') (Node 8.9+)
• require('@easypost/api/easypost.6-lts.js') (Node 6.9+)
• require('@easypost/api/easypost.legacy.js') (Node 0.10+)

If using @easypost/api v5 or later, you can simply require the base project which is built on Node v10+

Note on ES6 Usage

You can import specific versions of the compiled code if you're using later versions of Node and using @easypost/api prior to v5.

// Imports the un-transformed es6
import '@easypost/api/src/easypost';

// Use the following to import mininally transformed versions
import '@easypost/api/easypost.6-lts';
import '@easypost/api/easypost.8-lts';
import '@easypost/api/easypost.legacy.js'; // (v0.10)

Usage

A simple create & buy shipment example:

const EasyPost = require('@easypost/api');

const api = new EasyPost(process.env.EASYPOST_API_KEY);

const shipment = new api.Shipment({
  from_address: {
    street1: '417 MONTGOMERY ST',
    street2: 'FLOOR 5',
    city: 'SAN FRANCISCO',
    state: 'CA',
    zip: '94104',
    country: 'US',
    company: 'EasyPost',
    phone: '415-123-4567',
  },
  to_address: {
    name: 'Dr. Steve Brule',
    street1: '179 N Harbor Dr',
    city: 'Redondo Beach',
    state: 'CA',
    zip: '90277',
    country: 'US',
    phone: '4155559999',
  },
  parcel: {
    length: 8,
    width: 5,
    height: 5,
    weight: 5,
  },
});

shipment.save().then((s) => s.buy(shipment.lowestRate()).then(console.log).catch(console.log));

Options

You can construct an API instance with certain options:

const api = new Api('mykey', {
  timeout: 120000,
  baseUrl: 'https://api.easypost.com/v2/',
  useProxy: false,
  superagentMiddleware: (s) => s,
  requestMiddleware: (r) => r,
});

timeout

Time in milliseconds that should fail requests.

baseUrl

Change the base URL that the API library uses. Useful if you proxy requests from a frontend through a server.

useProxy

Disable using the API key. Useful if you proxy requests from a frontend through a server.

superagentMiddleware

Function that takes superagent and returns superagent. Useful if you need to wrap superagent in a function, such as many superagent libraries do.

import superagentLib from 'some-superagent-lib';

const api = new Api('my-key', {
  superagentMiddleware: (s) => superagentLib(s),
});

requestMiddleware

Function that takes a superagent request and returns that request. Useful if you need to hook into a request:

import superagentLib from 'some-superagent-lib';

const api = new Api('my-key', {
  requestMiddleware: (r) => {
    r.someLibFunction(SOME_CONFIG_VALUE);
    return r;
  },
});

Interactive CLI

Replace easypost.js with whatever compatabile version you wish, as defined under Compatibility.

API_KEY=yourkey ./repl.js --local easypost.js

Documentation

API Documentation can be found at: https://easypost.com/docs/api.

Upgrading major versions of this project? Refer to the Upgrade Guide.

Development

# Install dependencies
make install

# Update dependencies
make update

# Build the project
make build

# Lint the project
make lint

# Fix lint errors
make fix

# Format the project
make format

# Run tests (these will be transpiled on the fly)
EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test

# Run tests with coverage (these will be transpiled on the fly)
EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage

# Run security analysis
make scan

# Generate library documentation
make docs

# Update submodules
git submodule init
git submodule update --remote

Typescript Definitions (Beta)

Starting with v5.3.0, this project has bundled Typescript definitions included. These definitions are in their infancy and are not yet recommended for production applications. We welcome the community's help in maintaining these definitions and contributing improvements as we add missing types or make small corrections.

Typescript Exclusions

• We do not provide a DefinitelyTyped version of these definitions at this time
• Predefined packages (due to maintenance cost)
• Carrier service levels (due to maintenance cost)
• Carrier list (due to maintenance cost)

Typescript TODOs

• Nullability for every field may need additional work
• Error codes may not be comprehensive

Testing

The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses Pollyjs (AKA: VCR) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run. If you receive errors about a cassette expiring, delete and re-record the cassette to ensure the data is up-to-date.

Sensitive Data: We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.

Making Changes: If you make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.

Test Data: The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user with the exception of the USPS carrier account ID (see Unit Test API Keys for more information) which has a fallback value of our internal testing user's ID. Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).

Unit Test API Keys

The following are required on every test run:

• EASYPOST_TEST_API_KEY
• EASYPOST_PROD_API_KEY

Some tests may require an EasyPost user with a particular set of enabled features such as a Partner user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:

• USPS_CARRIER_ACCOUNT_ID (eg: one-call buying a shipment for non-EasyPost employees)
• PARTNER_USER_PROD_API_KEY (eg: creating a referral user)
• REFERRAL_CUSTOMER_PROD_API_KEY (eg: adding a credit card to a referral user)

Changelog

v5.9.0 (2023-01-11)

• Adds new beta billing functionality for ReferralCustomer users
  • addPaymentMethod can add a pre-existing Stripe bank account or credit card to your EasyPost account
  • refundByAmount refunds your wallet by a dollar amount
  • refundByPaymentLog refunds you wallet by a PaymentLog ID