Order Pricing

::: Add an order pricing plugin :::

Order price adapter gives you more control on how you charge based on an order. In order to add custom order pricing logic you first need to implement IPricingAdapter and register is to the global OrderPricingDirector which implements the IPricingDirector.

There can be more than one order pricing plugin configurations and all of them will be executed based on there orderIndex value. Order pricing adapter with lower orderIndex will be executed first

below is an example or IPricingAdapter implementation that will add $50 to each order as service charge

export const ShopOrderPricingAdapter: IOrderPricingAdapter = {
  key: 'shop-order-service-pricing',
  label: 'Default service charge price',
  version: '1.0.0',
  orderIndex: 1,

  isActivatedFor: (context) => {
    return true;
  },

  actions: (params) => {
    const calculation: OrderPricingCalculation[] = [];
    const { context } = params;
    const { currency } = context;
    const resultSheet = OrderPricingSheet({ currency });

    return {
      calculate: async () => {
        const resultRaw = resultSheet.getRawPricingSheet();
        resultSheet.addPayment({ amount: 100, taxAmount: 0 });
        resultRaw.forEach(
          ({ amount, category }) =>
            ShopOrderPricingAdapter.log(`Order Pricing Calculation -> ${category} ${amount}`),
          resultRaw,
        );
        return resultRaw;
      },
      getContext: () => params.context,
      resultSheet: () => resultSheet,
      getCalculation: () => calculation,
    };
  },
};

• isActiveFor(context: OrderPricingAdapterContext): Used to activate or de-active a particular order price plugin based on the current context of the order or any other business rule.
• calculate: is where the actual calculation of the order price is done based on the calculation items defined for the adapter.
• getContext: returns the current order payment price plugin context.
• resultSheet: return the price sheet items that are applied on the price adapter.

import {OrderPriceDirector} from '@unchainedshop/core-orders'

OrderPriceDirector.registerAdapter(ShopOrderPricingAdapter)