Using our XML API makes it easy for you to synchronise your existing booking system with your mtvan account.
Here’s an example request to create a new booking on mtvan:
[stextbox id="xmlcode"]
String
String
new_booking
Integer
String
String
String
YYYY-MM-DD HH:MM:SS
String String
String
YYYY-MM-DD HH:MM:SS
YYYY-MM-DD HH:MM:SS
String String
String
YYYY-MM-DD HH:MM:SS
YYYY-MM-DD HH:MM:SS
String
String
String
String
String
Integer
Integer
String
[/stextbox]
| Element Name | Data Type | Required | Definition | Valid Values |
|---|---|---|---|---|
| mtvan_request | Compound | Yes | Root Element | |
| login | Compound | Yes | Login Element | |
| id | String | Yes | API Username | Any String |
| password | String | Yes | API Password | Any String |
| request_type | String | Yes | Determines expected action of this request |
new_booking |
| booking_details | Compound | Yes | Booking Container | |
| customerid | Integer | Yes | Customer ID | Any Valid Integer |
| job_reference | String | Yes | Your Job Reference | |
| short_description | String | No | A Short Description | |
| booked_by | String | Yes | Name | |
| quote_datetime | Date & Time | Yes | The Date and Time the Quote was given | YYYY-MM-DD HH:MM:SS |
| from_address | Compound | Yes | From Address Element | |
| address | String | Yes | The Collection Address | |
| postcode | String | Yes | The Collection Postcode | Any Valid Postcode |
| country | String | Yes | The Collection Country Code (from list) | String Length: 2 chars |
| time_type | String | Yes | Time Type (From List - By, Before, Between etc) | String Length: 2 chars |
| time | Date & Time | Yes | The Collection Date and Time | YYYY-MM-DD HH:MM:SS |
| time_between | Date & Time | No | Use if between time_type is chosen | YYYY-MM-DD HH:MM:SS |
| to_address | Compound | Yes | To Address Element | |
| address | String | Yes | The Delivery Address | |
| postcode | String | Yes | The Delivery Postcode | Any Valid Postcode |
| country | String | Yes | The Delivery Country Code (from list) | String Length: 2 chars |
| time_type | String | Yes | Time Type (From List - By, Before, Between etc) | String Length: 2 chars |
| time | Date & Time | Yes | The Delivery Date and Time | YYYY-MM-DD HH:MM:SS |
| time_between | Date & Time | No | Use if between time_type is chosen | YYYY-MM-DD HH:MM:SS |
| comments | String | No | Any Booking Comments | |
| instructions | String | No | Any Driver Instructions | |
| waitandreturn | String | No | Wait and Return | String: Y or N |
| openforbids | String | No | Send Alerts to users and receive offers | String: Y or N |
| service_type | String | Yes | The Intended Service Type (from list) | String Length: 2 chars |
| miles | Integer | No | Miles | |
| noofitems | Integer | No | Number of items to collect | |
| itemdescription | String | No | A Description of the item(s) |
If you’d like us to receive/supply more data via XML please contact us and ask to speak with one of our developers.