Shipmate | Vendure Docs

Create shipments in Shipmate on every order placed, to automate your order fulfillment process.

Getting started

Add the plugin to your vendure-config.ts

import { ShipmatePlugin } from '@pinelab/vendure-plugin-shipmate';...plugins: [  ShipmatePlugin.init({    apiUrl: 'https://api.shipmate.co.uk/v1.2', // Or https://api-staging.shipmate.co.uk/v1.2 for the testing environment    shouldSendOrder: function ( ctx: RequestContext, order: Order): Promise<boolean> | boolean {      // Sample implementation that only sends orders with less than 5 items to Shipmate      return order.totalQuantity < 5;    }  }),  AdminUiPlugin.init({    port: 3002,    route: 'admin',    app: compileUiExtensions({      outputPath: path.join(__dirname, '__admin-ui'),      extensions: [        ShipmatePlugin.ui        ... // your other plugin UI extensions      ],    }),  }),... // your other plugins]

Compile the admin UI to include the Shipmate configuration page
Log in to your Shipmate account.
Note down your API key from Profile > Settings > API Keys
Create two webhooks. One with trigger Tracking Status updates to Collected and one with Tracking Status updates to Delivered, pointing to url https://<your Vendure server>/shipmate. Set JSON as format. This will make sure your Vendure Order is synced when the shipment is being Shipped or Delivered.
Start Vendure, log in, and navigate to Settings > Shipmate
Fill in your API Key, username and password. The plugin will authenticate as the given user when creating shipments.
Fill in both Auth tokens from the created webhooks that were created in Shipmate. You can find it on the webhook detail screen. The plugin uses this token to validate if incoming events are really from Shipmate.
Click 'Save'

Test the plugin

Place a test order.

Upgraded to Vendure 3.5.3

Documentation update

Updated official documentation URL

Upgrade to Vendure to 3.3.2

Update Vendure to 3.1.1

Include catch-unknown dependency

Hydrate sensible relations before passing order into shouldSendOrder

Add ShipmatePluginConfig.shouldSendOrder (#498)

Don't throw erros from /shipmate endpoint (#509)

Divide by 100 when passing OrderLine.proratedUnitPriceWithTax to Items.item_value

Log warning when failed to cancel a shipment in Shipmate

Update compatibility range (#480)

Slice all string fields in Shipmate payload to 40 characters

Cancel and Recreate Shipment when Order is modified

Updated Vendure to 2.2.6

Don't throw errors when an order doesn't exist, but log and return. This can happen because shipments are also manually created in Shipmate.

Removed unused @Index(), because a unique constraint was already present

Removed unused custom field order.shipmateReference

Exporting plugin, services and entities in the main package

Correctly copy admin UI files to dist

Initial setup of the plugin.

Getting started

Add the plugin to your vendure-config.ts

import { ShipmatePlugin } from '@pinelab/vendure-plugin-shipmate';...plugins: [  ShipmatePlugin.init({    apiUrl: 'https://api.shipmate.co.uk/v1.2', // Or https://api-staging.shipmate.co.uk/v1.2 for the testing environment    shouldSendOrder: function ( ctx: RequestContext, order: Order): Promise<boolean> | boolean {      // Sample implementation that only sends orders with less than 5 items to Shipmate      return order.totalQuantity < 5;    }  }),  AdminUiPlugin.init({    port: 3002,    route: 'admin',    app: compileUiExtensions({      outputPath: path.join(__dirname, '__admin-ui'),      extensions: [        ShipmatePlugin.ui        ... // your other plugin UI extensions      ],    }),  }),... // your other plugins]

Compile the admin UI to include the Shipmate configuration page

Note down your API key from Profile > Settings > API Keys

Create two webhooks. One with trigger Tracking Status updates to Collected and one with Tracking Status updates to Delivered, pointing to url https://<your Vendure server>/shipmate. Set JSON as format. This will make sure your Vendure Order is synced when the shipment is being Shipped or Delivered.

Start Vendure, log in, and navigate to Settings > Shipmate

Fill in your API Key, username and password. The plugin will authenticate as the given user when creating shipments.

Fill in both Auth tokens from the created webhooks that were created in Shipmate. You can find it on the webhook detail screen. The plugin uses this token to validate if incoming events are really from Shipmate.

Click 'Save'

Test the plugin

Place a test order.