Getting Started

In order to add your service to ShipEngine Connect and make it available within our suite of e-commerce applications, you'll need to create a JavaScript application.

Our documentation assumes that you understand:

  • Basic programming concepts
  • How to use a terminal on your computer
  • JavaScript/NodeJS
  • TypeScript (optional - you can use plain JavaScript)

After upgrading your @shipengine/connect to at least 2.0.0 using the npm install -g @shipengine/connect, run the init command connect init. This will walk you through the initialization process and will generate the brand new template.

These new application types contain both the runtime & the domain specific library needed for your app to run (Order Source/Carrier). The hope is that you will have a normal JavaScript/TypeScript development lifecycle while working on these projects using familiar commands like npm start, npm run-script build, npm test to work on your project locally.

ShipEngine Connect Apps

ShipEngine Connect apps are NPM packages that export an object matching a certain structure. Please see our app definitions and sample apps for more information.

Your app will run in our hosted Node.js runtime environment. We take care of hosting, scaling, and providing high-availability access to your application so you can just focus on the core functionality.

Developer Tooling

The ShipEngine Connect NPM package provides TypeScript type definitions, enumerations, and helper classes for you to use in your app. It also provides a command-line interface to aid you in your application development.

Use it to:

API Documentation

Carrier API Reference

Using the npm start command will bring up a locally running server (port 3005 by default), going to localhost:3005/docs will bring up the documentation associated with your application type.

App Definition Documentation

The metadata associated with an app is used to drive behavior in our products and is what our customers see. You can learn more about the metadata associated with your app type at the following links.

Testing

There are a few ways to test your application.

  • Install a testing framework like Jest, Mocha, etc and write local unit tests
  • Run npm start and hit your module locally using something like Postman
  • Run the connect publish command and test your application in the ShipEngine Connect ShipStation Development Environment

A helpful tip is to publish your application to the development environment to test out the expected functionality and then do a connect logs to get request response logs from your module, and then use those requests to create unit tests or postman requests for local trouble shooting.