This repo contains sample ShipEngine Integration Platform apps to demonstrate and test various features of the ShipEngine Integration Platform platform.
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. The ShipEngine Integration Platform 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.
To make things even easier for you, the ShipEngine Integration Platform supports JSON, JSON5, YAML, and even TypeScript files in addition to plain JavaScript. You can use any combination of these file types for different parts of your app.
This repo contains several sample ShipEngine Integration Platform apps that demonstrate various features of the platform.
| Sample Company | Description |
|---|---|
 |
This is a carrier integration, written in JavaScript. It uses YAML to define service offerings and JSON for form definitions. |
 |
This is a carrier integration written entirely in JavaScript, including its service offerings and form definitions. |
 |
This is a carrier integration written entirely in TypeScript, including its service offerings and form definitions. |
| [COMING SOON] | A sample order app written in JavaScript, YAML, and JSON is coming soon |
| [COMING SOON] | A sample order app written entirely in JavaScript is coming soon |
| [COMING SOON] | A sample order app written entirely in TypeScript is coming soon |