README.md

Vendure Plugin for syncing orders to MyParcel

Sends orders to MyParcel on fulfillment.

Permission

This plugin adds a custom permission 'SetMyParcelConfig' that is needed to set MyParcel config via the admin interface.

Plugin installation

Add this to your plugins in vendure-config.ts:

MyparcelPlugin.init({
  vendureHost: 'https://your-vendure-host.io',
  syncWebhookOnStartup: true, // If you want to automatically set vendureHost as webhook on MyParcel account
});

Add this to your AdminUiPlugin:

AdminUiPlugin.init({
  ...
    app
:
compileUiExtensions({
  outputPath: path.join(__dirname, '__admin-ui'),
  extensions: [MyparcelPlugin.ui],
})
})

Start Vendure and login:

1. Go to Settings > MyParcel and fill in your MyParcel API key.
2. Create a shipmentMethod with MyParcel fulfillment.
3. Place an order and select the shippingMethod.
4. Go to the Admin UI and click on fulfill
5. Your shipment should be in your MyParcel account.

Reach out to me at pinelab.studio if you need any help.

Contributing

Contributions always welcome!

Dev-server

⚠️ This will update the webhook in de configured MyParcel account!

1. yarn start starts the dev-server.
2. localhost:3050/admin will have an order already placed ready to be fulfilled.

Testing

Run yarn test to run e2e tests

Enjoying our plugins?

Enjoy the Pinelab Vendure plugins? Consider becoming a sponsor.

Or check out pinelab.studio for more articles about our integrations.