Brokerware API Updates

3PL API Updates

UpdateShipment API

• Prevented UpdateShipment API endpoints from advancing shipment statuses beyond "Booked" for Freight Bazaar buyer-side shipments.
• Added an API error response when attempting unauthorized status transitions from "Booked" or later stages:
  • "This is a freight bazaar shipment, the status cannot be updated via API"

Global API

• Added a global API endpoint allowing clients to write spot quotes and participate carriers directly to a load, while enhancing global carrier lookup functionality.
  • New Global Endpoint for Participating Carriers:
    • Allows writing carrier quote details and notes directly to the "Participating Carriers" section on a load.
    • Automatically logs each API entry into the Shipment Notes.
    • Carrier Lookup & Matching: Automatically searches by MC or DOT number to pull primary send-rate-request contact details from existing carrier profiles.
    • Quick Carrier Fallback: If no matching carrier is found, automatically creates a new "Quick Carrier" (per Task 28686) using the provided carrier name and contact information.
    • Write to Participating Carriers
  • Global Carrier Endpoint Search Enhancements:
    • Updated api/clientv1/carriers to support searching across single or multiple parameters simultaneously (MC, DOT, Carrier Name).
    • Global Carrier Search

GetLoads API & CreateShipment API

• GetLoads and CreateShipment API responses now include stop sequence data for multi-stop shipments:
  • items[]: Returns pickupStopSequence and dropStopSequence, indicating which stop each commodity is picked up and dropped at.
  • stops[]: Returns stopSequence.
• Corrected an issue in the Global GetLoads API endpoint where stale estimated delivery dates were returned after updates in the UI.
• Rate and Create with Rate ID v1.4+

ratingWithRateQuoteID API

• API Version Support (v1.4+): Released v1.4 endpoints (/api/v1.4/RatingWithRateQuoteId and /api/clientv1.4/RatingWithRateQuoteId) supporting multi-stop rating and shipment creation. Legacy endpoints (v1.0 to v1.3) remain unaffected and backward-compatible.
• Multi-Stop Address Routing (shipmentAddresses): Added support for sending intermediate pickup and drop stops (stopSequence 2 through 998) via the shipmentAddresses array. Main shipper (stopSequence 1) and consignee (stopSequence 999) continue to pull automatically from top-level request fields.
• Commodity-to-Stop Mapping: Enhanced item payload to support explicit pickupStopSequence and dropStopSequence parameters to link commodities to specific load/drop points.
• Address Book & Location Code Integration: Passing a locationCode now resolves against customer address book entries (LoadPoint for pickups, DropPoint for drops) to automatically inherit address details, public/private notes, stop-specific accessorials, and stop window open/close times.
• Fallback Address Logic: Gracefully falls back to standard single-stop rating using primary shipper and consignee locations when shipmentAddresses is omitted.
• Time & Window Resolutions: Added logic to inherit ready/close times and estimated delivery windows based on a defined priority hierarchy (request input → address book hours → customer preferences).
• Rating with Rate Quote ID