UPS Tracker

UPSTracker is a Node.js service that fetches real-time order status from UPS using tracking numbers. It handles cookie management and API requests to UPS’s platform, providing detailed tracking information for your shipments.

Requirements

• Node.js v20.17.0 or higher

Installation

1. Clone the repository:

git clone https://github.com/daferferso/ups_tracker.git
cd ups_tracker

2. Install dependencies:

npm install

Usage

1. Set up your environment variables: Create a .env file in the root directory of your project based on the provided .env.template. Ensure that the variables are set according to your environment. For example:

   HOST_URL=http://localhost:3000
   API_TITLE=UPS Tracker API
   API_VERSION=1.0.0
   API_DESCRIPTION="UPSTracker is a Node.js service that fetches real-time order status from UPS using tracking numbers. It handles cookie management and API requests to UPS’s platform, providing detailed tracking information for your shipments."
   
   

2. Start the server:

npm run dev

3. Access the API documentation at:

http://localhost:3000/api-docs

4. To retrieve the status of a package, send a GET request to:

http://localhost:3000/{trackingNumber}

Example Request

curl -X GET http://localhost:3000/1Z3TWW700308932865

Response

• 200 OK: Package status retrieved successfully.
• 400 Bad Request: Invalid tracking number.
• 500 Internal Server Error: Error retrieving the package status.

License

This project is licensed under the MIT License.