@shipengine/js-api NPM | npm.io

3.13.1 • Published 12 days ago

Install

Weekly downloads

-

License

-

Repository

Last release

12 days ago

ShipEngine JS Api

The shipengine/js-api library instantiates a batteries-included, vanilla JavaScript client for interacting with the ShipEngine API. The client provides a set of fully-typed methods that map directly to ShipEngine API operations^1, bound to a user specified via platform token.

Features:

Converts all outbound JSON keys to snake_case for consumption by the ShipEngine API.
Converts all inbound JSON keys to camelCase for use in JS.
Attempts to refresh expired tokens on 401 Unauthorized responses, followed by retrying the original request.
Logs all requests and responses to the console.

In addition to the client, the shipengine/js-api lib provides TypeScript types for all ShipEngine API entities.

Basic Usage

import { ShipEngineAPI } from "@shipengine/js-api";

const client = new ShipEngineAPI("your-platform-token", {
  // Used when attempting to refresh the token on 401 responses
  getToken: async () => {
    return "your-platform-token";
  },
});

client.shipments.list().then((response) => {
  console.log(response.data);
  // > an object matching the response schema of https://shipengine.github.io/shipengine-openapi/#operation/list_shipments
});

@shipengine/elements

12 days ago

4 months ago

22 days ago

2 months ago

26 days ago

6 months ago

5 months ago

14 days ago

3 months ago

3 months ago

8 months ago

28 days ago

4 months ago

2 months ago

27 days ago

6 months ago

22 days ago

4 months ago

27 days ago

2 months ago

8 months ago

8 months ago

9 months ago

9 months ago

1 year ago

1 year ago

12 months ago

10 months ago

10 months ago

11 months ago

11 months ago

1 year ago

12 months ago

9 months ago

9 months ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

9 months ago

11 months ago

11 months ago

10 months ago

1 year ago

11 months ago

10 months ago

1 year ago

1 year ago

1 year ago

10 months ago

10 months ago

10 months ago

12 months ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago