freight-club 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1
+
+- Initial release, covering Freight Club API Documentation version 2.4: `bookShipment`, `cancelShipment`, `downloadBol`, `exportOrders`, `getBol`, `getLabel`, `getOrderStatus`, `getRate`, `getRates` and `getShipmentTracking`

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stores.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,278 @@
+# freight-club
+
+[![Build Status](https://github.com/stores-com/freight-club/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/stores-com/freight-club/actions?query=workflow%3ATest+branch%3Amain)
+[![Coverage Status](https://coveralls.io/repos/github/stores-com/freight-club/badge.svg?branch=main)](https://coveralls.io/github/stores-com/freight-club?branch=main)
+[![npm version](https://img.shields.io/npm/v/freight-club)](https://www.npmjs.com/package/freight-club)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+The Freight Club API is an interface that allows you to set up an integrated experience between your daily operations and our application. APIs give you the ability to manage all your Parcel or LTL shipments with capabilities that include rating shipments, creating Bills of Lading or parcel labels, booking shipments with carriers and getting tracking information from those bookings.
+
+https://api.freightclub.com/ApiDoc/index
+
+## Requirements
+
+Node.js 18 or later. This package uses the built-in `fetch` and has no HTTP dependency.
+
+## Usage
+
+```javascript
+const FreightClub = require('freight-club');
+
+const freightClub = new FreightClub({
+    api_token: 'your_api_token'
+});
+```
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `api_token` | | Freight Club API token, without the `Bearer ` prefix. Request one under Manage API Tokens in the Freight Club application, or use the testing token from the API documentation. |
+| `timeout` | `60000` | Milliseconds to wait before aborting a request. Rating fans out to Freight Club's carrier network and waits up to 40 seconds (the `maxTime` default) for the slowest carrier. |
+| `url` | `https://api.freightclub.com` | API endpoint. |
+
+Every method that makes a request also accepts a `timeout` option, which overrides the constructor value for that call only.
+
+```javascript
+const response = await freightClub.getRates(request, { timeout: 45000 });
+```
+
+### Errors
+
+A response other than 200 produces an [HttpError](https://www.npmjs.com/package/@stores.com/http-error), thrown from the promise.
+
+```javascript
+try {
+    await freightClub.bookShipment(request);
+} catch (err) {
+    console.log(err.message);      // '400 Bad Request'
+    console.log(err.cause.status); // 400
+    console.log(err.json);         // the parsed response body
+    console.log(err.text);         // the raw response body
+}
+```
+
+A request that never reaches Freight Club — an unparseable `url`, a network failure, or a timeout — produces the error `fetch` itself raised, with no `cause.status`.
+
+### freightClub.bookShipment(request, [options])
+
+Supplying the quote number returned by GetRate and GetRates, this method books a shipment at that specific quoted rate with the chosen carrier. Carriers require a contact `Email` at booking (Error Code 13010), even though Freight Club's API documentation marks it optional.
+
+**Example**
+
+```javascript
+const response = await freightClub.bookShipment({
+    OrderReferenceID: 'SALEID1660782849',
+    PickupDate: '2022-08-18',
+    Quote: '1151240419',
+    DropOffLocation: {
+        Address: {
+            Address1: '5678 Destination Street',
+            City: 'Action',
+            Country: 'US',
+            LocationType: 'Residential',
+            ProvinceState: 'MT',
+            ZipCode: '59002'
+        },
+        Contact: {
+            Email: 'recipient@example.com',
+            Firstname: 'Recipient',
+            Lastname: 'Person',
+            PhoneNumber: '5555555556'
+        }
+    },
+    PickupLocation: {
+        Address: {
+            Address1: '1234 Source Street',
+            City: 'Seattle',
+            Country: 'US',
+            LocationType: 'Commercial',
+            ProvinceState: 'WA',
+            ZipCode: '98101'
+        },
+        Contact: {
+            Email: 'sender@example.com',
+            Firstname: 'Sender',
+            Lastname: 'Person',
+            PhoneNumber: '5555555558'
+        }
+    },
+    ShipmentInformation: {
+        Boxes: [
+            {
+                Category: 'CasedGoodsFurniture',
+                DeclaredValue: {
+                    Unit: 'USD',
+                    Value: 500
+                },
+                Description: 'Pack of 4',
+                Dimension: {
+                    Height: 10,
+                    Length: 10,
+                    Unit: 'Inch',
+                    Width: 10
+                },
+                Quantity: 1,
+                Sku: 'SKU12345',
+                Weight: {
+                    Unit: 'LB',
+                    Value: 45
+                }
+            }
+        ]
+    }
+});
+
+console.log(response.ConfirmationNumber); // 'FC59086014T860'
+```
+
+### freightClub.cancelShipment(confirmationNumber, [options])
+
+This method will cancel a shipment, provided it has not yet been picked up by a carrier.
+
+**Example**
+
+```javascript
+const response = await freightClub.cancelShipment('FC59086014T860');
+
+console.log(response.Message); // 'We have successfully processed your shipment cancellation'
+```
+
+### freightClub.downloadBol(confirmationNumber, [options])
+
+This method will download the Bill of Lading (BOL) document itself for LTL shipments based on the confirmation number generated after successful booking of an order. It resolves to a `Buffer` containing the document rather than a JSON envelope. Pass `shipmentlabelFormatType` (`Pdf` or `Zpl`) to choose the format.
+
+**Example**
+
+```javascript
+const document = await freightClub.downloadBol('FC59086014T860', { shipmentlabelFormatType: 'Pdf' });
+
+fs.writeFileSync('bol.pdf', document);
+```
+
+### freightClub.exportOrders([query], [options])
+
+This method will retrieve all the booked orders for the period you specify, up to a 30-day window. Freight Club's API documentation says an export without parameters returns the current day's orders, but the API actually requires `from` and `to` — and `to` is exclusive, so a single day is `{ from: '2022-08-14', to: '2022-08-15' }`.
+
+**Example**
+
+```javascript
+const response = await freightClub.exportOrders({ from: '2022-08-14', to: '2022-08-20' });
+```
+
+### freightClub.getBol(confirmationNumber, [options])
+
+This method will return Bill of Lading (BOL) details for LTL shipments based on the confirmation number generated after successful booking of an order. Pass `contentBase64Needed: true` to also receive the document itself in the response's `ContentBase64` field.
+
+**Example**
+
+```javascript
+const response = await freightClub.getBol('FC59086014T860', { contentBase64Needed: true });
+
+console.log(response.BolURL);
+console.log(response.TrackingNumber); // 'FCT1009624087737139200'
+```
+
+### freightClub.getLabel(confirmationNumber, [options])
+
+This method will return the shipping label based on the confirmation number generated after a successful booking.
+
+**Example**
+
+```javascript
+const response = await freightClub.getLabel('FC59086014T860', { shipmentlabelFormatType: 'Zpl' });
+
+console.log(response.LabelURL);
+```
+
+### freightClub.getOrderStatus(query, [options])
+
+This method will retrieve the current status of a specific order providing the essential details like important shipping dates and the current status. Query by `OrderID`, `OrderReferenceID`, `WayBill` or `TrackingNo`.
+
+**Example**
+
+```javascript
+const response = await freightClub.getOrderStatus({ OrderID: '59086014' });
+
+console.log(response[0].CurrentStatus);     // 'Pending Pickup'
+console.log(response[0].Dates.DeliveryEta); // '08-26-2022'
+```
+
+### freightClub.getRate(request, [options])
+
+Use GetRate when you're only interested in a specific Service Level. This call is much quicker than the GetRates call and will provide all available rates for carriers that are open to your account for the Service Level you specified.
+
+Pass `maxTime` (seconds, 1-40, default 40) to trade quote quantity for speed.
+
+**Example**
+
+```javascript
+const response = await freightClub.getRate({
+    OrderReferenceID: 'SALEID1660782849',
+    PickupDate: '2022-08-18',
+    ServiceLevel: 'Threshold',
+    DropOffLocation: {
+        Address1: '5678 Destination Street',
+        City: 'Action',
+        Country: 'US',
+        LocationType: 'Residential',
+        ProvinceState: 'MT',
+        ZipCode: '59002'
+    },
+    PickupLocation: {
+        Address1: '1234 Source Street',
+        City: 'Seattle',
+        Country: 'US',
+        LocationType: 'Commercial',
+        ProvinceState: 'WA',
+        ZipCode: '98101'
+    },
+    TotalDeclaredValue: {
+        Unit: 'USD',
+        Value: 500
+    },
+    Accessorials: [],
+    Boxes: [
+        {
+            Category: 'CasedGoodsFurniture',
+            DeclaredValue: {
+                Unit: 'USD',
+                Value: 500
+            },
+            Description: 'Pack of 4',
+            Dimension: {
+                Height: 10,
+                Length: 10,
+                Unit: 'Inch',
+                Width: 10
+            },
+            FreightClass: '50',
+            Quantity: 1,
+            Sku: 'SKU12345',
+            Weight: {
+                Unit: 'LB',
+                Value: 45
+            }
+        }
+    ]
+}, { maxTime: 30 });
+
+console.log(response.Quote);                 // the cheapest quote number
+console.log(response.TotalNetCharge.Value);  // its all-in cost
+console.log(response.CompositeRateQuote);    // every quote, including per-carrier NetCharge, ExtraServices and transit time
+```
+
+### freightClub.getRates(request, [options])
+
+This method will retrieve quotes for all Service Levels, valid for both LTL and Parcel depending on Carriers that are open to your account. The request shape matches `getRate` without the `ServiceLevel` field.
+
+### freightClub.getShipmentTracking(query, [options])
+
+This method will return a list of tracking information for specific shipments. Query by `trackingNo`, `wayBillNumber`, `shipmentId` or `CustomerNumber`.
+
+**Example**
+
+```javascript
+const response = await freightClub.getShipmentTracking({ shipmentId: '59086014' });
+
+console.log(response[0].TrackingCategory); // 'Pending Pickup'
+console.log(response[0].Description);      // 'WAITING FOR PICKUP'
+```

package/index.js

@@ -0,0 +1,346 @@
+const HttpError = require('@stores.com/http-error');
+
+/**
+ * Throws an HttpError for any non-200 response and returns the parsed JSON body otherwise.
+ *
+ * @private
+ * @param {Response} res - A fetch Response.
+ * @returns {Promise.<Object>} The parsed JSON body.
+ * @throws {HttpError} If the response status is not 200.
+ */
+async function parseResponse(res) {
+    if (res.status !== 200) {
+        throw await HttpError.from(res);
+    }
+
+    return await res.json();
+}
+
+/**
+ * A client for the Freight Club API.
+ *
+ * @param {Object} args - Client options.
+ * @param {string} args.api_token - Freight Club API token, without the `Bearer ` prefix.
+ * @param {number} [args.timeout=60000] - Milliseconds to wait before aborting a request.
+ * @param {string} [args.url='https://api.freightclub.com'] - API endpoint.
+ * @see https://api.freightclub.com/ApiDoc/index
+ * @example
+ * const freightClub = new FreightClub({ api_token: 'your_api_token' });
+ */
+function FreightClub(args) {
+    const _options = Object.assign({
+        // Freight Club fans rate requests out to its carrier network and waits up to 40 seconds (the maxTime default) for the slowest carrier
+        timeout: 60000,
+        url: 'https://api.freightclub.com'
+    }, args);
+
+    /**
+     * Supplying the quote number returned by GetRate and GetRates, this method books a shipment at that specific quoted rate with the chosen carrier.
+     *
+     * @param {Object} request - A BookShipment request. Carriers require a contact Email at booking (Error Code 13010), even though Freight Club's API documentation marks it optional.
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Object>} The booking confirmation, including ConfirmationNumber and ShipmentNumber.
+     * @throws {HttpError} If the response status is not 200.
+     * @see https://api.freightclub.com/ApiDoc/index
+     * @example
+     * const booking = await freightClub.bookShipment(request, { timeout: 180000 });
+     */
+    this.bookShipment = async function(request, options = {}) {
+        const res = await fetch(`${_options.url}/Book/BookShipment`, {
+            body: JSON.stringify(request),
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`,
+                'Content-Type': 'application/json'
+            },
+            method: 'POST',
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will cancel a shipment, provided it has not yet been picked up by a carrier.
+     *
+     * @param {string} confirmationNumber - The confirmation number supplied from a successful booking.
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Object>} The cancellation result.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const cancellation = await freightClub.cancelShipment('FC59086014T860');
+     */
+    this.cancelShipment = async function(confirmationNumber, options = {}) {
+        const res = await fetch(`${_options.url}/Cancel/CancelShipment/${encodeURIComponent(confirmationNumber)}`, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will download the Bill of Lading (BOL) document itself for LTL shipments based on the confirmation number generated after successful booking of an order.
+     *
+     * @param {string} confirmationNumber - The confirmation number supplied from a successful booking.
+     * @param {Object} [options] - Per-call options.
+     * @param {string} [options.shipmentlabelFormatType] - The file format to receive: Pdf or Zpl.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Buffer>} The Bill of Lading document itself.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const bolDocument = await freightClub.downloadBol('FC59086014T860', { shipmentlabelFormatType: 'Pdf' });
+     */
+    this.downloadBol = async function(confirmationNumber, options = {}) {
+        let url = `${_options.url}/Bol/DownloadBol/${encodeURIComponent(confirmationNumber)}`;
+
+        if (options.shipmentlabelFormatType) {
+            url += `?shipmentlabelFormatType=${options.shipmentlabelFormatType}`;
+        }
+
+        const res = await fetch(url, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        if (res.status !== 200) {
+            throw await HttpError.from(res);
+        }
+
+        // DownloadBol streams the document itself rather than a JSON envelope
+        return Buffer.from(await res.arrayBuffer());
+    };
+
+    /**
+     * This method will retrieve all the booked orders for the period you specify, up to a 30-day window. Freight Club's API documentation says the parameters are optional, but the API requires both.
+     *
+     * @param {Object} query - Export parameters.
+     * @param {string} query.from - The starting date from which orders were placed (YYYY-MM-DD).
+     * @param {string} query.to - The last date that orders were placed (YYYY-MM-DD), EXCLUSIVE: a single day is from=2022-08-14, to=2022-08-15.
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Array.<Object>>} The booked orders for the period.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const orders = await freightClub.exportOrders({ from: '2022-08-14', to: '2022-08-20' });
+     */
+    this.exportOrders = async function(query, options = {}) {
+        let url = `${_options.url}/api/orders/export`;
+        const queryString = new URLSearchParams(query).toString();
+
+        if (queryString) {
+            url += `?${queryString}`;
+        }
+
+        const res = await fetch(url, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will return Bill of Lading (BOL) details for LTL shipments based on the confirmation number generated after successful booking of an order.
+     *
+     * @param {string} confirmationNumber - The confirmation number supplied from a successful booking.
+     * @param {Object} [options] - Per-call options.
+     * @param {boolean} [options.contentBase64Needed] - Also return the document itself, Base64-encoded in the response's ContentBase64 field.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Object>} Bill of Lading details, including TrackingNumber, CarrierWayBill and BolURL.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const bol = await freightClub.getBol('FC59086014T860', { contentBase64Needed: true });
+     */
+    this.getBol = async function(confirmationNumber, options = {}) {
+        const query = new URLSearchParams();
+
+        if (options.contentBase64Needed !== undefined) {
+            query.set('contentBase64Needed', options.contentBase64Needed);
+        }
+
+        let url = `${_options.url}/Bol/GetBol/${encodeURIComponent(confirmationNumber)}`;
+        const queryString = query.toString();
+
+        if (queryString) {
+            url += `?${queryString}`;
+        }
+
+        const res = await fetch(url, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will return the shipping label based on the confirmation number generated after a successful booking.
+     *
+     * @param {string} confirmationNumber - The confirmation number supplied from a successful booking.
+     * @param {Object} [options] - Per-call options.
+     * @param {boolean} [options.contentBase64Needed] - Also return the label itself, Base64-encoded in the response's ContentBase64 field.
+     * @param {string} [options.shipmentlabelFormatType] - The file format to receive: Pdf or Zpl.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Object>} Label details, including LabelURL.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const label = await freightClub.getLabel('FC59086014T860', { shipmentlabelFormatType: 'Zpl' });
+     */
+    this.getLabel = async function(confirmationNumber, options = {}) {
+        const query = new URLSearchParams();
+
+        if (options.contentBase64Needed !== undefined) {
+            query.set('contentBase64Needed', options.contentBase64Needed);
+        }
+
+        if (options.shipmentlabelFormatType) {
+            query.set('shipmentlabelFormatType', options.shipmentlabelFormatType);
+        }
+
+        let url = `${_options.url}/Label/GetLabel/${encodeURIComponent(confirmationNumber)}`;
+        const queryString = query.toString();
+
+        if (queryString) {
+            url += `?${queryString}`;
+        }
+
+        const res = await fetch(url, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will retrieve the current status of a specific order providing the essential details like important shipping dates and the current status.
+     *
+     * @param {Object} query - Order status parameters; supply one of them.
+     * @param {string} [query.OrderID] - The Freight Club OrderID linked to the shipment.
+     * @param {string} [query.OrderReferenceID] - The order reference assigned to the shipment, URL encoded to account for spaces.
+     * @param {string} [query.TrackingNo] - The tracking number assigned to the shipment.
+     * @param {string} [query.WayBill] - The carrier's waybill value assigned to the shipment.
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Array.<Object>>} The matching orders' statuses, including CurrentStatus, ConfirmationNumber and Dates.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const statuses = await freightClub.getOrderStatus({ OrderID: '59086014' });
+     */
+    this.getOrderStatus = async function(query, options = {}) {
+        const res = await fetch(`${_options.url}/api/orders/orderstatus?${new URLSearchParams(query)}`, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * Use GetRate when you're only interested in a specific Service Level. This call is much quicker than the GetRates call and will provide all available rates for carriers that are open to your account for the Service Level you specified.
+     *
+     * @param {Object} request - A GetRate request. A ServiceLevel is required (Error Code 9036).
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.maxTime] - Seconds to wait for the carrier network to return quotes, 1 to 40 (default 40); Freight Club recommends 10 or greater.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Object>} The quotes, with the cheapest quote number in Quote and its cost in TotalNetCharge.
+     * @throws {HttpError} If the response status is not 200.
+     * @see https://api.freightclub.com/ApiDoc/index
+     * @example
+     * const rate = await freightClub.getRate(request, { maxTime: 30 });
+     */
+    this.getRate = async function(request, options = {}) {
+        let url = `${_options.url}/Rate/GetRate`;
+
+        if (options.maxTime) {
+            url += `?maxTime=${options.maxTime}`;
+        }
+
+        const res = await fetch(url, {
+            body: JSON.stringify(request),
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`,
+                'Content-Type': 'application/json'
+            },
+            method: 'POST',
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will retrieve quotes for all Service Levels, valid for both LTL and Parcel depending on Carriers that are open to your account.
+     *
+     * @param {Object} request - A GetRates request. Despite rating all Service Levels, a ServiceLevel is still required (Error Code 9036).
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.maxTime] - Seconds to wait for the carrier network to return quotes, 1 to 40 (default 40); Freight Club recommends 10 or greater.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Object>} The quotes, with the cheapest quote number in Quote and its cost in TotalNetCharge.
+     * @throws {HttpError} If the response status is not 200.
+     * @see https://api.freightclub.com/ApiDoc/index
+     * @example
+     * const rates = await freightClub.getRates(request, { maxTime: 30 });
+     */
+    this.getRates = async function(request, options = {}) {
+        let url = `${_options.url}/Rate/GetRates`;
+
+        if (options.maxTime) {
+            url += `?maxTime=${options.maxTime}`;
+        }
+
+        const res = await fetch(url, {
+            body: JSON.stringify(request),
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`,
+                'Content-Type': 'application/json'
+            },
+            method: 'POST',
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+
+    /**
+     * This method will return a list of tracking information for specific shipments.
+     *
+     * @param {Object} query - Tracking parameters; supply one of them.
+     * @param {string} [query.CustomerNumber] - Your own internal reference number, URL encoded to account for spaces.
+     * @param {string} [query.shipmentId] - Internal Freight Club order number (OrderId).
+     * @param {string} [query.trackingNo] - Freight Club tracking number.
+     * @param {string} [query.wayBillNumber] - Waybill number which Freight Club uses to register the shipment.
+     * @param {Object} [options] - Per-call options.
+     * @param {number} [options.timeout] - Milliseconds to wait before aborting the request, overriding the constructor value.
+     * @returns {Promise.<Array.<Object>>} The shipment's tracking events.
+     * @throws {HttpError} If the response status is not 200.
+     * @example
+     * const tracking = await freightClub.getShipmentTracking({ shipmentId: '59086014' });
+     */
+    this.getShipmentTracking = async function(query, options = {}) {
+        const res = await fetch(`${_options.url}/api/tracking/ShipmentTracking?${new URLSearchParams(query)}`, {
+            headers: {
+                'Authorization': `Bearer ${_options.api_token}`
+            },
+            signal: AbortSignal.timeout(options.timeout || _options.timeout)
+        });
+
+        return await parseResponse(res);
+    };
+}
+
+module.exports = FreightClub;

package/package.json

@@ -0,0 +1,36 @@
+{
+    "dependencies": {
+        "@stores.com/http-error": "~1.2.0"
+    },
+    "description": "The Freight Club API is an interface that allows you to set up an integrated experience between your daily operations and our application. APIs give you the ability to manage all your Parcel or LTL shipments with capabilities that include rating shipments, creating Bills of Lading or parcel labels, booking shipments with carriers and getting tracking information from those bookings.",
+    "devDependencies": {
+        "@eslint/js": "*",
+        "globals": "*"
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "keywords": [
+        "freight",
+        "freight club",
+        "logistics",
+        "ltl",
+        "shipping",
+        "tracking"
+    ],
+    "license": "MIT",
+    "name": "freight-club",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/stores-com/freight-club.git"
+    },
+    "scripts": {
+        "coveralls": "node --test --test-force-exit --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=lcov.info test && coveralls < lcov.info",
+        "test": "node --test --test-force-exit test",
+        "test:only": "node --test --test-force-exit --test-only test"
+    },
+    "version": "0.0.1"
+}