@shipengine/integration-platform-sdk NPM

ShipEngine Integration Platform SDK

This is the official SDK for building ShipEngine Integration Platform apps.

About ShipEngine Integration Platform Apps

Apps are just NPM packages that export an object with properties and methods that define the app's functionality.

An app must have a package.json file in its root directory, which specifies its name, version number, and dependencies. This SDK (@shipengine/integration-platform-sdk) must be listed as a dependency or devDependency.

Other than that, the folder structure and file names are entirely up to you. As long as your app exports an object with the right structure, it doesn't matter whether that object is defined in a single file or spread across many files.

Installation

You can install the ShipEngine Integration Platform SDK via npm.

npm install @shipengine/integration-platform-sdk

Example Usage

In addition to our documentation, you can also look at these sample apps to learn how to use the ShipEngine Integration Platform SDK. The sample apps demonstrate various features of the platform, as well as different posible ways to build and structure apps.