@inflightit/api-plugin-orders/src/resolvers/Order/orderSummary.js

Orders plugin for the Reaction API

import getRateObjectForRate from "@reactioncommerce/api-utils/getRateObjectForRate.js";

/**
 * @name Order/orderSummary
 * @method
 * @memberof Order/GraphQL
 * @summary Returns an aggregate of all fulfillmentGroup summaries to provide a single orderSummary
 * @param {Object} context An object with request-specific state
 * @param {Object} order - Result of the parent resolver, which is a Order object in GraphQL schema format
 * @returns {Object} An object containing order pricing information from all fulfillmentGroups
 */
export default async function orderSummary(context, order) {
  const { currencyCode, shipping: fulfillmentMethods } = order;
  const totalDiscounts = [];
  const totalShipping = [];
  const totalSubtotal = [];
  const totalSurcharges = [];
  const totalTaxableAmount = [];
  const totalTaxes = [];
  const totalTotal = [];

  // Loop over each fulfillmentGroup (shipping[]), and push all values into `totalX` array
  fulfillmentMethods.forEach((fulfillmentMethod) => {
    const { invoice: { discounts, shipping, subtotal, surcharges, taxableAmount, taxes, total } } = fulfillmentMethod;

    totalDiscounts.push(discounts);
    totalShipping.push(shipping);
    totalSubtotal.push(subtotal);
    totalSurcharges.push(surcharges);
    totalTaxableAmount.push(taxableAmount);
    totalTaxes.push(taxes);
    totalTotal.push(total);
  });

  // Reduce each `totalX` array to get order total from all fulfillmentGroups
  const totalDiscountsAmount = totalDiscounts.reduce((acc, value) => acc + value, 0);
  const totalShippingAmount = totalShipping.reduce((acc, value) => acc + value, 0);
  const totalSubtotalAmount = totalSubtotal.reduce((acc, value) => acc + value, 0);
  const totalSurchargesAmount = totalSurcharges.reduce((acc, value) => acc + value, 0);
  const totalTaxableAmountAmount = totalTaxableAmount.reduce((acc, value) => acc + value, 0);
  const totalTaxesAmount = totalTaxes.reduce((acc, value) => acc + value, 0);
  const totalTotalAmount = totalTotal.reduce((acc, value) => acc + value, 0);

  // Calculate effective tax rate of combined fulfillmentGroups
  const effectiveTaxRate = totalTaxableAmountAmount > 0 ? totalTaxesAmount / totalTaxableAmountAmount : 0;

  return {
    discountTotal: {
      amount: totalDiscountsAmount,
      currencyCode
    },
    effectiveTaxRate: getRateObjectForRate(effectiveTaxRate),
    fulfillmentTotal: {
      amount: totalShippingAmount,
      currencyCode
    },
    itemTotal: {
      amount: totalSubtotalAmount,
      currencyCode
    },
    surchargeTotal: {
      amount: totalSurchargesAmount,
      currencyCode
    },
    taxableAmount: {
      amount: totalTaxableAmountAmount,
      currencyCode
    },
    taxTotal: {
      amount: totalTaxesAmount,
      currencyCode
    },
    total: {
      amount: totalTotalAmount,
      currencyCode
    }
  };
}