MaxOptra icon

MaxOptra

Route optimization and delivery logistics platform for orders, drivers, and proof of delivery.

1 trigger10 searches7 actionsInstant (webhooks)Auth: API key

AI-assisted documentation11 min read

This documentation is compiled from our integration source code, internal specs for MaxOptra, its official API documentation and anonymized requests logs we collect from our support team[2].

Open MaxOptra on WEXTL →

Connecting MaxOptra takes an active account plus an API access token from your account settings — no other setup is required.[3]

  • API KeypasswordRequired

    An API key can be generated via the API Keys screen in the Settings tab. Only account administrators can do that.

    [1]
  • Account Domain NametextRequired

    You can take domain name from your youraccountname.maxoptra.com is your account URL. Only youraccountname should be provided.

    [1]
  1. Log in to your WEXTL account, add the MaxOptra node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your MaxOptra account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting MaxOptra to WEXTL®
Video slide demonstrates how to integrate MaxOptra in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch EventsTrigger

No fields documented.

Get a DriverAction
Input fields[3]
FieldType
Driver IDRequired
choice
Output fields[3]
FieldType
Reference Numbertext
Nametext
Commenttext
Telephonetext
Assigned Vehicle Referencetext
Assigned Vehicle Nametext
Cost Per Hournumber
Distribution Centre Referencetext
Distribution Centre Nametext
Territoriesarray
Start Of Day Locationtext
Start Of Day Addresstext
Visit Distribution Centre Starttext
End Of Day Locationtext
End Of Day Addresstext
Visit Distribution Centre Endtext
Driving Limitnumber
Run Duration Limitnumber
Duty Time Limitnumber
Availabilityobject
Mondayobject
Tuesdayobject
Wednesdayobject
Thursdayobject
Fridayobject
Saturdayobject
Sundayobject
Defaultobject
Holidayobject
Get an OrderAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Reference Numbertext
Consignment Referencetext
Distribution Centre Referencetext
Distribution Centre Nametext
Tasktext
Prioritytext
Vehicle Requirementsarray
Additional Instructionstext
Client Nametext
Contact Persontext
Contact Numbertext
Contact Emailemail
Additional Contact Emailsarray
Customer Locationobject
Reference Numbertext
Nametext
Addresstext
Latitudenumber
Longitudenumber
W 3w Addresstext
Notification Preferencesobject
Allow SMSboolean
Allow Emailboolean
Territory Referencetext
Stop Sequencetext
Time Windowsarray
Capacity 1number
Capacity 2number
4other output fields
Get an Order Proof of DeliveryAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Order Reference Numbertext
Signatory Nametext
Signature Timedate
Signature Imageurl
Get Order Execution DetailsAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Order Reference Numbertext
Assigned Driver Referencetext
Assigned Driver Nametext
Assigned Vehicle Referencetext
Assigned Vehicle Namedate
Planned Arrival Timedate
Planned Completion Timedate
Stop Numbernumber
Total Stops In Runnumber
Etatext
Fact Arrival Time GPSdate
Fact Completion Time GPSdate
Fact Arrival Time Reporteddate
Fact Completion Time Reporteddate
Fail Reasontext
Fail Commenttext
Statustext
Run Numbernumber
Get Order Tracking DetailsAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Order Reference Numbertext
Current Positionobject
Latitudenumber
Longitudenumber
Statustext
List Order AttachmentsSearch
Input fields[3]
FieldType
Order IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Attachment Reference Numbertext
Order Reference Numbertext
Commenttext
Image Smallurl
Image Fullurl
Search Driver ShiftsSearch
Input fields[3]
FieldType
Driver ReferenceRequired
choice
Shift DateRequired
date
Limitnumber
Output fields[3]
FieldType
Driver Nametext
Driver Referencetext
Vehicle Nametext
Vehicle Referencetext
Shift Datetext
Shift Start Timedate
Shift End Timedate
Runsarray
Total Working Timenumber
Total Driving Timenumber
Total Distancenumber
Search DriversSearch
Input fields[3]
FieldType
DC Referencechoice
Limitnumber
Output fields[3]
FieldType
Reference Numbertext
Nametext
Assigned Vehicle Referencetext
Assigned Vehicle Nametext
Distribution Centre Referencetext
Distribution Centre Nametext
Search OrdersSearch
Input fields[3]
FieldType
Assigned Driverschoice
Assigned Vehicleschoice
Consignment Referencetext
DC Referencechoice
Expandchoice
Planned Arrival Fromdate
Planned Arrival Todate
Shift Date Fromdate
Shift Date Todate
Statusestext
Territory Referencetext
Time Window Fromdate
Time Window Todate
Limitnumber
Output fields[3]
FieldType
Reference Numbertext
Consignment Referencetext
Distribution Centre Referencetext
Distribution Centre Nametext
Tasktext
Prioritytext
Client Nametext
Contact Persontext
Customer Locationobject
Reference Numbertext
Nametext
Addresstext
Latitudenumber
Longitudenumber
W 3w Addresstext
Capacity 1number
Capacity 2number
Operation Durationnumber
Custom Fieldsobject
Statustext
Status Last Updatedtext
Widget Tracking Detailsobject
Tracking IDtext
External Tracking Uritext
Search Vehicle ShiftsSearch
Input fields[3]
FieldType
Vehicle ReferenceRequired
choice
Shift DateRequired
date
Limitnumber
Output fields[3]
FieldType
Driver Nametext
Driver Referencetext
Vehicle Nametext
Vehicle Referencetext
Shift Datetext
Shift Start Timedate
Shift End Timedate
Runsarray
Total Working Timenumber
Total Driving Timenumber
Total Distancenumber
Create a DriverAction
Input fields[3]
FieldType
Reference NumberRequired
text
NameRequired
text
Cost Per HourRequired
number
Distribution Centre ReferenceRequired
choice
Commenttext
Telephonetext
Assigned Vehicle Referencetext
Distribution Centre Nametext
Territoriesarray
Territory Referencetext
Start Of Day Locationchoice
Visit Distribution Centre Startchoice
End Of Day Locationchoice
Visit Distribution Centre Endchoice
Driving Limitnumber
Run Duration Limitnumber
Duty Time Limitnumber
Availabilityobject
Defaultobject
Holidayobject
Mondayobject
Tuesdayobject
Wednesdayobject
Thursdayobject
Fridayobject
Saturdayobject
Sundayobject
Output fields[3]
FieldType
Reference Numbertext
Nametext
Commenttext
Telephonetext
Assigned Vehicle Referencetext
Assigned Vehicle Nametext
Cost Per Hournumber
Distribution Centre Referencetext
Distribution Centre Nametext
Territoriesarray
Start Of Day Locationtext
Start Of Day Addresstext
Visit Distribution Centre Starttext
End Of Day Locationtext
End Of Day Addresstext
Visit Distribution Centre Endtext
Driving Limitnumber
Run Duration Limitnumber
Duty Time Limitnumber
Availabilityobject
Mondayobject
Tuesdayobject
Wednesdayobject
Thursdayobject
Fridayobject
Saturdayobject
Sundayobject
Defaultobject
Holidayobject
Create an OrderAction
Input fields[3]
FieldType
Reference Numbertext
Pricenumber
Consignment Referencetext
Distribution Centre Referencechoice
Taskchoice
Prioritychoice
Vehicle Requirementsarray
Additional Instructionstext
Client Nametext
Contact Persontext
Contact Numbertext
Contact Emailemail
Additional Contact Emailsarray
Customer Locationobject
Reference Numbertext
Nametext
Addresstext
Latitudenumber
Longitudenumber
What3Words Addresstext
Notification Preferencesobject
Allow SMSboolean
Allow Emailboolean
Stop Sequencechoice
Time Windowsarray
Order Datedate
Capacity 1number
Capacity 2number
3other input fields
Output fields[3]
FieldType
Reference Numbertext
Delete a DriverAction
Input fields[3]
FieldType
Driver IDRequired
choice
Output fields[3]
FieldType
Warningsobject
Codetext
Nametext
Detailstext
Fieldtext
Delete an OrderAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Warningsobject
Codetext
Nametext
Detailstext
Fieldtext
Make an API Calluniversal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Update a DriverAction
Input fields[3]
FieldType
Driver IDRequired
choice
Reference Numbertext
Nametext
Cost Per Hournumber
Distribution Centre Referencechoice
Commenttext
Telephonetext
Assigned Vehicle Referencetext
Distribution Centre Nametext
Territoriesarray
Territory Referencetext
Start Of Day Locationchoice
Visit Distribution Centre Startchoice
End Of Day Locationchoice
Visit Distribution Centre Endchoice
Driving Limitnumber
Run Duration Limitnumber
Duty Time Limitnumber
Availabilityobject
Defaultobject
Holidayobject
Mondayobject
Tuesdayobject
Wednesdayobject
Thursdayobject
Fridayobject
Saturdayobject
Sundayobject
Output fields[3]
FieldType
Reference Numbertext
Nametext
Commenttext
Telephonetext
Assigned Vehicle Referencetext
Assigned Vehicle Nametext
Cost Per Hournumber
Distribution Centre Referencetext
Distribution Centre Nametext
Territoriesarray
Start Of Day Locationtext
Start Of Day Addresstext
Visit Distribution Centre Starttext
End Of Day Locationtext
End Of Day Addresstext
Visit Distribution Centre Endtext
Driving Limitnumber
Run Duration Limitnumber
Duty Time Limitnumber
Availabilityobject
Mondayobject
Tuesdayobject
Wednesdayobject
Thursdayobject
Fridayobject
Saturdayobject
Sundayobject
Defaultobject
Holidayobject
Update an OrderAction
Input fields[3]
FieldType
Order IDRequired
choice
Reference Numbertext
Pricenumber
Consignment Referencetext
Distribution Centre Referencechoice
Taskchoice
Prioritychoice
Vehicle Requirementsarray
Additional Instructionstext
Client Nametext
Contact Persontext
Contact Numbertext
Contact Emailemail
Additional Contact Emailsarray
Customer Locationobject
Reference Numbertext
Nametext
Addresstext
Latitudenumber
Longitudenumber
What3Words Addresstext
Notification Preferencesobject
Allow SMSboolean
Allow Emailboolean
Stop Sequencechoice
Time Windowsarray
Order Datedate
Capacity 1number
4other input fields
Output fields[3]
FieldType
Reference Numbertext
Consignment Referencetext
Distribution Centre Referencetext
Distribution Centre Nametext
Tasktext
Prioritytext
Vehicle Requirementsarray
Additional Instructionstext
Client Nametext
Contact Persontext
Contact Numbertext
Contact Emailemail
Additional Contact Emailsarray
Customer Locationobject
Reference Numbertext
Nametext
Addresstext
Latitudenumber
Longitudenumber
W 3w Addresstext
Notification Preferencesobject
Allow SMSboolean
Allow Emailboolean
Territory Referencetext
Stop Sequencetext
Time Windowsarray
Capacity 1number
Capacity 2number
4other output fields

Look for MaxOptra templates in the WEXTL template library.

Browse templates →
  1. WEXTL® MaxOptra Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for MaxOptra.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12