# Install this plugin
npm install @pinelab/vendure-plugin-myparcel

Vendure MyParcel Plugin

Plugin for sending placed orders to MyParcel.

Getting started

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

import { MyparcelPlugin } from '@pinelab/vendure-plugin-myparcel';

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

2. Start Vendure and go to Settings > Channels, open the channel you want to configure and select the MyParcel tab. Tick Enabled and fill in your MyParcel API key. Configuration is stored per channel as Channel custom fields, so no Admin UI extension needs to be compiled.
3. Create a shipmentMethod with MyParcel fulfillment.
4. Place an order and select the shippingMethod.
5. Go to the Admin UI and click on fulfill
6. Your shipment should be in your MyParcel account.

The myparcelEnabled toggle controls whether MyParcel is active for a channel. When it is off (or no API key is set), the plugin is disabled for that channel.

Customs information for shipments outside the EU

MyParcel requires additional customs information for shipments outside the EU. When you ship outside the EU, you should implement the getCustomsInformationFn when initializing the plugin:

MyparcelPlugin.init({
  vendureHost: 'https://your-vendure-host.io',
  getCustomsInformationFn: (orderItem) => {
    return {
      weightInGrams: (orderItem.line.productVariant.product.customFields as any)
        .weight,
      classification: (
        orderItem.line.productVariant.product.customFields as any
      ).hsCode,
      countryCodeOfOrigin: 'NL',
    };
  },
});

You can find more information about the classification codes here.

Custom shipment strategy

If you want more control over the data that is send over to MyParcel, then you can implement a custom shipmentStrategy.

The shipment strategy needs to implement MyParcelShipmentStrategy and should containt the getShipment method. This method returns the shipment object for MyParcel API reference

If you only need to change the recipient or the options, you can extend the MyParcalDefaultShipmentStrategy and overwrite the method you need.

• getOptions
• getRecipient

class CustomShipmentStrategy extends MyParcalDefaultShipmentStrategy {
  getShipment(address: OrderAddress, order: Order, customsContent: string) {
    const shipment: MyparcelShipment = {
      carrier: 2, //bpost. Only available on sendmyparcel.be
      reference_identifier: order.code,
      options: this.getOptions(address, order, customsContent),
      recipient: this.getRecipient(address, order, customsContent),
    };

    return shipment;
  }
}

Pass you strategy to the MyparcelPlugin config.

MyparcelPlugin.init({
  vendureHost: 'https://your-vendure-host.io',
  shipmentStrategy: new CustomShipmentStrategy(),
});

getCustomsInformationFn will still be processed after the custom shipment strategy