API Documentation Updates — May 2026
1 day ago by Shuai Tseng
Added
- Added response payload examples for the Update Order endpoint, with separate responses for notes and destination updates. https://docs.onfleet.com/reference/update-order
- Added JSON response examples for each task state (0–3) to the State article. https://docs.onfleet.com/reference/state
- Added a JSON example to the Completion Requirements article showing signature and photo requirement fields. https://docs.onfleet.com/reference/completion-requirements
- Added JSON examples to the Dependencies article illustrating pickup-dropoff task relationships with shortened, relevant-fields-only payloads. https://docs.onfleet.com/reference/dependencies
- Added JSON request body and response examples to the Automatic Assignment article. https://docs.onfleet.com/reference/automatic-assignment
- Added PHP, JavaScript, and Python code examples for the Update Webhook endpoint. https://docs.onfleet.com/reference/update-webhook
- Added webhook payload examples for predictedTaskDelay (trigger 30) and smsRecipientResponseMissed (trigger 14). https://docs.onfleet.com/reference/webhook-payload-examples
Changed
- Changed the metadata documentation to include Teams as a supported entity and consolidated the Metadata Object and Working with Metadata pages into one. https://docs.onfleet.com/reference/metadata
- Changed the Proof of Delivery retrieval URL from legacy CloudFront domain to uploads.us.prod.onfleet.com. https://docs.onfleet.com/reference/proof-of-delivery-retrieval
Fixed
- Fixed inconsistent field naming and response payload in the Get Order endpoint; corrected URL formatting, grammar, and updated response to display both shortId and orderShortId. https://docs.onfleet.com/reference/orders
- Fixed the Reject Order article to clarify the endpoint returns a 200 with an empty body; corrected the request body field from reasons to reason and fixed grammar. https://docs.onfleet.com/reference/reject-order
- Fixed grammar errors, clarified required vs optional recipient fields, updated the JSON example, and added a description for the Orders resource in the Create Order endpoint documentation. https://docs.onfleet.com/reference/create-order
- Fixed inconsistent URL parameter naming across the Orders page; standardized all endpoints to use orderShortId and corrected grammar. https://docs.onfleet.com/reference/orders