Skip to content
Last updated

Changelog

[2025-06-03]

This update introduces cargo insurance functionality across multiple endpoints. Users can now specify cargo values for insurance premium calculation, with the system returning corresponding premium amounts in the responses.

Added

  • GET /api/v2/rates/advanceSearch

    • New request parameter cargo_value (number, 0-1000000)
    • New response field premium
  • POST /api/v2/createOrder

    • New request parameter containers.cargo_value (number, 0-1000000)
    • New response fields containers.cargo_value and containers.premium
  • POST /api/ltl/quotes

    • New request parameter cargo_value (integer, 1-30000)
    • New response field premium

[2025-07-01]

Added LTL shipment tracking via rate_numbers.

Added

  • GET /api/ltl/shipments
    • New request parameter rate_numbers (Array[string], 1-30000)

[2025-08-22]

Added LTL label created webhook support for real-time notifications when LTL labels are created.

Added

  • POST /ltl/label/created/webhook/
    • New webhook endpoint for LTL label creation events
    • Event type: ltl.label.created
    • Payload includes order number, serial number, PRO number, label URL, and creation timestamp

[2025-08-25]

Updated webhook documentation to support only LTL-specific events and standardized event naming conventions.

Changed

  • Webhook Event Support: Limited webhook events to 6 LTL-specific events only

    • ltl.shipment.created - LTL shipment creation events
    • ltl.shipment.status.updated - LTL shipment status update events
    • ltl.billOfLading.created - LTL bill of lading creation events
    • ltl.proofOfDelivery.created - LTL proof of delivery creation events
    • ltl.certificateOfInsurance.created - LTL certificate of insurance creation events
    • ltl.label.created - LTL label creation events
  • API Paths: Updated all webhook event endpoints to use /ltl/ prefix for consistency

  • Event Descriptions: Enhanced descriptions to clearly indicate LTL-specific functionality

  • Schema Updates: Updated event type examples and removed deprecated invoice-related schemas

Removed

  • invoice.created webhook event and related OrderInvoiceCreated schema
  • Legacy non-LTL webhook event support

[2025-11-11]

Added HomeDelivery accessorial support for LTL Quote API, enabling residential home delivery services. Introduced FTL (Full Truckload) API support for quote creation, shipment management, and tracking.

Added

  • POST /api/ltl/quotes

    • New accessorial option homeDelivery in destination_accessorials array
    • New request parameter floor (integer, optional) - Floor number, only available when home delivery is selected
    • New request parameter is_elevator (boolean, optional) - Elevator availability, only available when home delivery is selected
    • New request parameter is_military (boolean, optional) - Whether it is a military address, only available when home delivery is selected
  • POST /api/v2/ftl/quotes

    • New endpoint for creating FTL quotes
    • Returns rate details including trailer type, trailer size, rate, and transit days
  • POST /api/v2/ftl/shipments

    • New endpoint for creating FTL shipments
    • Supports comprehensive shipment details including pickup and destination information, time windows, and cargo details
  • GET /api/v2/ftl/shipments/tracking

    • New endpoint for tracking FTL shipments
    • Supports querying up to 50 order numbers at once
    • Returns tracking events with status, location, event type, and event date

Changed

  • POST /api/ltl/quotes
    • When homeDelivery is selected in destination_accessorials:
      • destination_address_type must be residential
      • destination_accessorials can only contain homeDelivery
      • pickup_address_type must be business
      • pickup_accessorials must be empty