Skip to content

This Particular example demonstrates how you can sync shipping delivered status from ShipEngine into Moltin via Webhook API.

License

Notifications You must be signed in to change notification settings

uniquelyparticular/sync-shipengine-to-moltin

Repository files navigation

@particular./sync-shipengine-to-moltin

npm version semantic-release code style: prettier CircleCI dependency status: david

Update Moltin order shipping status when delivered in ShipEngine

Asynchronous microservice that is triggered by ShipEngine webhooks to update Order data inside of moltin.

Built with Micro! 🤩

🛠 Setup

Both a moltin and ShipEngine account are needed for this to function.

Create a .env at the project root with the following credentials:

MOLTIN_CLIENT_ID=
MOLTIN_CLIENT_SECRET=

Find your MOLTIN_CLIENT_ID and MOLTIN_CLIENT_SECRET inside of your moltin Dashboard's API keys.

📦 Package

Run the following command to build the app

yarn install

Start the development server

yarn dev

The server will typically start on PORT 3000, if not, make a note for the next step.

Start ngrok (change ngrok port below from 3000 if yarn dev deployed locally on different port above)

ngrok http 3000

Make a note of the https ngrok URL provided.

⛽️ Usage

Next head over to the ShipEngine API Management>Webhooks area, add a new webhook with the following details:

Events Webhook URL Status
Any tracking event ngrok URL above_ On

🚀 Deploy

You can easily deploy this function to now.

Contact Adam Grohs @ Particular. for any questions.