Fulfillment APINovember 5, 2025: Payment Status🆕 Endpoint: Update Dispatch Payment Status
Change: New endpoint added
POST /api/fulfillments/id/{dispatchId}/update-payment-status
Notes:
‣ Allows authorized users with admin or owner roles to update the payment status of dispatches.
‣ The shipper and carrier will have different and distinct payment status tracking.
‣ Only dispatches in PENDING_DELIVERY, DELIVERED, CANCELED, or ARCHIVED status can be updated.
‣ Payment status values include UNPAID, PARTIALLY_PAID, and FULLY_PAID.
🔄 Endpoint: Search Dispatches
Change: New search field added:
paymentStatus - Array field for filtering dispatches by payment status.
Notes:
‣ You can now filter dispatches by payment status for easier tracking.
🔄 Endpoint: Get Dispatch
Change: New field added
paymentStatus - String field showing the current payment status of the dispatch.August 11, 2025: Dispatch Enhancements🔄 Endpoint: Create Dispatch
Change: Two new fields added for shippers:
shipperRequestedPickupDate
shipperRequestedDropOffDate
🔄 Endpoint: Respond to Dispatch
Change: New endpoint added for select carriers only.
🚨 Endpoint: Update Dispatch
Requires Inspection field must be included when updating a dispatch if selected in UI.
Notes:
‣ If the Requires Inspection checkbox is selected in the UI, include the requiresInspection field in your API update request.
‣ Missing this field will cause the update call to fail.
June 13, 2025: Dispatch Instructions & Notes🚨 Endpoint: Create Dispatch & Update Dispatch
Change: Instructions field appears as “Additional Terms” in the UI.
🚨 Endpoint: Update Dispatch
Change: Once a dispatch is created, both Instructions and preDispatchNotes become non-editable in UI and API.
Notes:
‣ You must still include Instructions and preDispatchNotes in Update Dispatch requests.
‣ Values must exactly match what was returned in the latest Get Dispatch response.
‣ If values do not match, the request will return an error.
‣ For updates after dispatch creation, use transportationReleaseNotes field.
‣ Ensure your systems are updated to avoid disruptions.
November 5, 2025: Payment Status
🆕 Endpoint: Update Dispatch Payment Status
Change: New endpoint added
Notes:
‣ Allows authorized users with admin or owner roles to update the payment status of dispatches.
‣ The shipper and carrier will have different and distinct payment status tracking.
‣ Only dispatches in PENDING_DELIVERY, DELIVERED, CANCELED, or ARCHIVED status can be updated.
‣ Payment status values include UNPAID, PARTIALLY_PAID, and FULLY_PAID.
🔄 Endpoint: Search Dispatches
Change: New search field added:
Notes:
‣ You can now filter dispatches by payment status for easier tracking.
🔄 Endpoint: Get Dispatch
Change: New field added
Change: New endpoint added
POST /api/fulfillments/id/{dispatchId}/update-payment-statusNotes:
‣ Allows authorized users with admin or owner roles to update the payment status of dispatches.
‣ The shipper and carrier will have different and distinct payment status tracking.
‣ Only dispatches in PENDING_DELIVERY, DELIVERED, CANCELED, or ARCHIVED status can be updated.
‣ Payment status values include UNPAID, PARTIALLY_PAID, and FULLY_PAID.
🔄 Endpoint: Search Dispatches
Change: New search field added:
paymentStatus - Array field for filtering dispatches by payment status.Notes:
‣ You can now filter dispatches by payment status for easier tracking.
🔄 Endpoint: Get Dispatch
Change: New field added
paymentStatus - String field showing the current payment status of the dispatch.August 11, 2025: Dispatch Enhancements
🔄 Endpoint: Create Dispatch
Change: Two new fields added for shippers:
🔄 Endpoint: Respond to Dispatch
Change: New endpoint added for select carriers only.
🚨 Endpoint: Update Dispatch
Requires Inspection field must be included when updating a dispatch if selected in UI.
Notes:
‣ If the Requires Inspection checkbox is selected in the UI, include the
‣ Missing this field will cause the update call to fail.
Change: Two new fields added for shippers:
shipperRequestedPickupDateshipperRequestedDropOffDate🔄 Endpoint: Respond to Dispatch
Change: New endpoint added for select carriers only.
🚨 Endpoint: Update Dispatch
Requires Inspection field must be included when updating a dispatch if selected in UI.
Notes:
‣ If the Requires Inspection checkbox is selected in the UI, include the
requiresInspection field in your API update request.‣ Missing this field will cause the update call to fail.
June 13, 2025: Dispatch Instructions & Notes
🚨 Endpoint: Create Dispatch & Update Dispatch
Change: Instructions field appears as “Additional Terms” in the UI.
🚨 Endpoint: Update Dispatch
Change: Once a dispatch is created, both
Notes:
‣ You must still include
‣ Values must exactly match what was returned in the latest Get Dispatch response.
‣ If values do not match, the request will return an error.
‣ For updates after dispatch creation, use
‣ Ensure your systems are updated to avoid disruptions.
Change: Instructions field appears as “Additional Terms” in the UI.
🚨 Endpoint: Update Dispatch
Change: Once a dispatch is created, both
Instructions and preDispatchNotes become non-editable in UI and API.Notes:
‣ You must still include
Instructions and preDispatchNotes in Update Dispatch requests.‣ Values must exactly match what was returned in the latest Get Dispatch response.
‣ If values do not match, the request will return an error.
‣ For updates after dispatch creation, use
transportationReleaseNotes field.‣ Ensure your systems are updated to avoid disruptions.
Listings APIJuly 25, 2025: Listings API V2🆕 Listings API V2
Change: New & refined API data fields:
‣ Contact & site info: contactName, contactPhone, contactCellPhone, contactEmailAddress
‣ Stop-Level Properties: locationName, locationType, and more
‣ Vehicle Properties: trim, doesNotSteer, doesNotRoll, inOpNotes, and more
‣ Shipping Specifications: height, width, length, weight
🚨 Transition timeline:
‣ July 25: Listings V2 documentation available
‣ August 20: Transition window begins; Listings V1 enters support mode
‣ February 2026: Listings V1 enters End-of-Life (EOL)
‣ May 2026: Listings V1 fully decommissioned
July 25, 2025: Listings API V2
🆕 Listings API V2
Change: New & refined API data fields:
‣ Contact & site info:
‣ Stop-Level Properties:
‣ Vehicle Properties:
‣ Shipping Specifications:
🚨 Transition timeline:
‣ July 25: Listings V2 documentation available
‣ August 20: Transition window begins; Listings V1 enters support mode
‣ February 2026: Listings V1 enters End-of-Life (EOL)
‣ May 2026: Listings V1 fully decommissioned
Change: New & refined API data fields:
‣ Contact & site info:
contactName, contactPhone, contactCellPhone, contactEmailAddress‣ Stop-Level Properties:
locationName, locationType, and more‣ Vehicle Properties:
trim, doesNotSteer, doesNotRoll, inOpNotes, and more‣ Shipping Specifications:
height, width, length, weight🚨 Transition timeline:
‣ July 25: Listings V2 documentation available
‣ August 20: Transition window begins; Listings V1 enters support mode
‣ February 2026: Listings V1 enters End-of-Life (EOL)
‣ May 2026: Listings V1 fully decommissioned