@pinelab/vendure-plugin-shipping-extensions
v2.8.0
Published
Vendure plugin for configurable shipping calculators and eligibility checkers.
Downloads
484
Readme
Shipping Extenions Vendure Plugin
Official documentation here
A collection of shipping calculators, checkers and promotion conditions that help you create customizable shipping options:
- Shipping eligibility checks based on the order weight and the order's country
- Distance based Shipping calculator, to calculate your shipping price based on the distance from your store
- A promotion condition that checks the order's shipping country. For example to only give free shipping to countries X, Y and Z
Getting started
- Add the following to the plugins in
vendure-config.ts
:
plugins: [
...
ShippingExtensionsPlugin.init({
/**
* Weight unit used in the eligibility checker
* and product customfield.
* Only used for displaying purposes
*/
weightUnit: "kg",
/**
* The name of the tab the customfield should be added to
* This can be an existing tab
*/
customFieldsTab: "Physical properties",
}),
AdminUiPlugin.init({
...
app: compileUiExtensions({
extensions: [
...
ShippingExtensionsPlugin.ui
],
...
}),
})
...
]
- Start your server
- Login to the admin UI and go to
Shipping methods
- Create a new shippingmethod
- Under
Shipping eligibility checker
you should seeCheck by weight and country
- Under
Shipping calculator
you should seeDistance Based Shipping Calculator
- Under Promotions conditions you should see
Order is in country
condition.
Shipping by weight and country options
Some examples:
- Create a shipping method for orders placed in Australia, with a total order weight between 10kg and 40kg
- Create a shipping method for all orders except the ones placed in Canada and Norway, with a total order weight below 1100 grams
The weight of a product can be configured on the customfield Product.weight
. You can configure the units to be in KG,
grams or whatever unit you like.
Custom weight calculation
By default, the plugin will calculate the weight of an order based on the custom field weight
:
- It will use the
productVariant.customFields.weight
of each order line - If that's not set, it will look for the
productVariant.product.customFields.weight
of each order line.
If you'd like to change this behaviour, you can specify a custom weightCalculationFunction
:
ShippingExtensionsPlugin.init({
weightCalculationFunction: (order) => {
// The order is hydrated with `order.lines.productVariant.product`
let totalOrderWeight = 0;
order.lines.forEach((line) => {
// Do your calculation magic here.
totalOrderWeight += line.myCustomWeightField
});
return totalWeight;
},
}),
Distance based shipping options
A configurable OrderAddressToGeolocationConversionStrategy
is used to convert the shippingAddress
of an Order
to a geographic latitudinal and longitudinal, which in turn is used to calculate the distance. The built-in strategy converts a UK postalcode to a lat/lon.
To support distance based calculation in other countries you'd have to implement your own strategy:
import {OrderAddressToGeolocationConversionStrategy} from '@pinelab/vendure-plugin-shipping-extensions'
export class USStreetLineToGeolocationConversionStrategy implements OrderAddressToGeolocationConversionStrategy{
async getGeoLocationForAddress(orderAddress: OrderAddress): Promise<GeoLocation> {
const location=//...result of a possible API call or any other lookup method
return {latitude: location.latitude, longitude: location.longitude}
}
}
Zone aware shipping tax calculation
To calculate a shipping tax(TaxRate
) based on the shipping or billing country of an order and a configurable TaxCategory
, you can use the zone-aware-flat-rate-shipping-calculator
included with this plugin.