In the dynamic world of e-commerce, tracking the status of an order is crucial for both businesses and customers. An effective tracking system ensures transparency and enhances the customer experience. In this article, we will explore a Node.js Express controller designed to handle order tracking. The controller fetches order details based on a tracking number and returns a status-specific response.

Introduction to the Code

This Node.js codebase is a part of an Express application. It is designed to fetch an order's status from a database and return a corresponding message. The code uses asynchronous operations to handle database queries and HTTP responses efficiently.

Key Components

1. Imports and Constants

const asyncHandler = require("../../../../../utils/asyncHandler");
const Orders = require("../../../../../models/Orders.model");
const ApiResponse = require("../../../../../utils/ApiResponse");
const OrderStatusEnum = require("../../../../../Constants");

• asyncHandler: A utility to manage asynchronous functions and error handling.

• Orders: The Mongoose model for accessing order data.

• ApiResponse: A utility to create standardized API responses.

• OrderStatusEnum: An object containing various order status constants.

2. Controller Definition

const orderTrackingController = asyncHandler(async (req, res) => {

The controller function, orderTrackingController, is wrapped in asyncHandler to handle asynchronous operations gracefully.

3. Extracting Tracking Number

const { trackingNumber } = req.body;

This line extracts the trackingNumber from the request body, which is needed to fetch the order details.

4. Fetching Order

const order = await Orders.findOne({ trackingNumber: trackingNumber }).populate("shippingAddressId");

This query fetches the order matching the provided tracking number and populates the shippingAddressId field with related data.

5. Handling Order Not Found

if (!order) {
    return res.status(404).json(new ApiResponse(404, null, "Order not found"));
}

If no order is found, the controller returns a 404 response with an appropriate message.

6. Creating Response Function

const createResponse = (heading, body) => new ApiResponse(200, { heading, body });

This helper function creates a standardized API response with a heading and body.

7. Determining the Response Based on Order Status

switch (order.orderStatus) {

The switch statement checks the orderStatus and constructs a response based on its value.

• Order Status: Pending

    case OrderStatusEnum.PENDING:
        response = createResponse(
            "Processed and Ready to Ship",
            "Your package has been processed and will be with our delivery partner soon."
        );
        break;
  

  • Order Status: Cancelled

      javascriptCopy codecase OrderStatusEnum.CANCELLED:
          response = createResponse(
              "Your Order has been cancelled",
              "Your order has been cancelled due to some reasons."
          );
          break;
    

  • Order Status: Placed

      javascriptCopy codecase OrderStatusEnum.PLACED:
          response = createResponse(
              "Reached our Logistics Facility",
              "Your package has arrived at our logistics facility from where it will be sent to the last mile hub."
          );
          break;
    

  • Order Status: Shipped

      javascriptCopy codecase OrderStatusEnum.SHIPPED:
          response = createResponse(
              "Shipped",
              `Your package is on the way to our last hub with tracking number ${order.trackingNumber} from where it will be delivered to you.`
          );
          break;
    

  • Order Status: Out for Delivery

      javascriptCopy codecase OrderStatusEnum.OUT_FOR_DELIVERY:
          response = createResponse(
              "Out for Delivery",
              `Our delivery partner will attempt to deliver your package today to ${order.shippingAddressId?.city}.`
          );
          break;
    

  • Order Status: Delivered

      javascriptCopy codecase OrderStatusEnum.DELIVERED:
          response = createResponse(
              "Delivered",
              `Your package has been delivered to ${order.shippingAddressId?.city}.`
          );
          break;
    

  • Default Case

      javascriptCopy codedefault:
          response = new ApiResponse(200, order, "Order status found successfully");
          break;
    

    8. Sending Response to Client

        return res.status(200).json(response);

This line sends the constructed response back to the client.

9. Exporting the Controller

•   module.exports = orderTrackingController;
  

This Node.js Express controller is a robust solution for tracking order statuses. By using asynchronous operations and clear, status-specific messages, it enhances the user experience and ensures efficient order tracking. Whether an order is pending, shipped, or delivered, this controller provides precise updates, keeping customers informed throughout the delivery process. This approach not only improves transparency but also builds trust with customers, making it an essential component of any e-commerce application.