To further develop the system and to enable customers to extend the use of the system to third party websites and applications, we have recently introduced a restfull API. This document contains the initial calls and requirements needed for our API to function. If you need a specific function that you can’t see documented, please email support@ivech.co.uk and a member of the team will get back to you.
\nThere are several prerequisites you must fulfil before being able to establish a successful connection.
\nSSL - All requests require SSL to be abled.
\nAPI Keys are a way of allowing the API to identify a user as they connect. This allows user permissions to be added and member information retrieved. You will require an API key before you can make a successful connection.
\nOnce an API key is acquired it can be used to connect to your API. The api key is passed via a key =>
value pair as a header variable as shown below:
X-API-KEY : YOUR_API_KEY_GOES_HERE
\niVech’s API base url is https://****.ivech.app/api
\nYou need to replace **** with your ivech site.
For security and privacy reasons, SSL is required to make a connection to the API.
In this documentation, with use demo.ivech.app as the base to test functionality, but this must be replaced with your base url.
\nThere have been several updates to the API this month. These changes are only applicable to iVech 3.5.0. and above.
\nNew add direct booking call
\nNew availability call for checking a specific vehicle reg
\nRe-writing of calls to include new ivech.app URL
\nGet a list of all branches in system and associated opening hours. You can use the branch index to pass into other functions to get availability and set the collection / delivery branches.
\n","urlObject":{"protocol":"https","path":["api","branch",""],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"9884ff7e-8c0f-47b2-81e6-70068f62c036"},{"name":"Get Branch Opening Times","id":"587dcd6f-24c8-478a-968d-e53c162eb028","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/branch/open_times?date=17-02-2017&branch=1","description":"Returns a list of when the branch is closed for special days as setup in the system.
\n","urlObject":{"protocol":"https","path":["api","branch","open_times"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"date","value":"17-02-2017"},{"key":"branch","value":"1"}],"variable":[]}},"response":[],"_postman_id":"587dcd6f-24c8-478a-968d-e53c162eb028"},{"name":"Get branch days closed","id":"e0e042c3-6cdf-49f5-8a95-6c280abc3504","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/branch/weekdays_closed ","description":"Returns a list of when the branch is closed
\n","urlObject":{"protocol":"https","path":["api","branch","weekdays_closed "],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0e042c3-6cdf-49f5-8a95-6c280abc3504"},{"name":"Get Special Closed Days","id":"2d71dcac-6796-4626-822a-204efcc066f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/branch/days_closed","description":"Returns a list of when the branch is closed for special days as setup in the system.
\n","urlObject":{"protocol":"https","path":["api","branch","days_closed"],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d71dcac-6796-4626-822a-204efcc066f8"}],"id":"3ad5f4c6-2c19-494d-b30f-6b50ab74764e","description":"You can utilise the branches section to check for opening hours and opening times.
\n","_postman_id":"3ad5f4c6-2c19-494d-b30f-6b50ab74764e"},{"name":"Rentals","item":[{"name":"Add Web Booking","id":"da37d517-2dd4-496a-bf10-623bb7c5c459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"details[title]","value":"Hirer Title","type":"text"},{"key":"details[firstname]","value":"Hirer Firstname","type":"text"},{"key":"details[lastname]","value":"Hirer Surname","type":"text"},{"key":"details[company_name]","value":"Company Name (if applicable)","type":"text"},{"key":"details[main_driver_house_name_no]","value":"Main Driver House Name / Number","type":"text"},{"key":"details[main_driver_street]","value":"Main Driver Street","type":"text"},{"key":"details[main_driver_town]","value":"Main Driver Town","type":"text"},{"key":"details[main_driver_postcode]","value":"Main Driver Postcode","type":"text"},{"key":"details[main_driver_telephone_number]","value":"Main Driver Mobile","type":"text"},{"key":"details[main_driver_additional_telephone_number]","value":"Main Driver Landline","type":"text"},{"key":"details[billing_email]","value":"Billing Email Address","type":"text"},{"key":"details[dob_day]","value":"DOB Day","type":"text"},{"key":"details[dob_month]","value":"DOB Month","type":"text"},{"key":"details[dob_year]","value":"DOB year","type":"text"},{"key":"details[driverslic]","value":"Driving Licence Number","type":"text"},{"key":"details[natinsurance]","value":"National Insurance Number","type":"text"},{"key":"collection_date","value":"Collection Date","type":"text"},{"key":"collection_time","value":"Collection Time","type":"text"},{"key":"return_date","value":"Return Date","type":"text"},{"key":"return_time","value":"Return Time","type":"text"},{"key":"vehicle_type","value":"Vehicle Type","type":"text"},{"key":"price_input","value":"Total Price","type":"text"},{"key":"details[name_on_card]","value":"Name on Card","type":"text"},{"key":"payment[masked_card_number]","value":"Last 4 Digits","type":"text"},{"key":"details[exp_date_month]","value":"Expiry Month","type":"text"},{"key":"details[exp_date_year]","value":"Expiry Year","type":"text"},{"key":"newsletter_registered","value":"Register for Newsletter (1 OR 0)","type":"text"},{"key":"details[driver_title]","value":"Driver Title","type":"text"},{"key":"details[driver_firstname]","value":"Driver Firstname","type":"text"},{"key":"details[driver_surname]","value":"Driver Surname","type":"text"},{"key":"details[driver_house_name_no]","value":"Driver House Name Number","type":"text"},{"key":"details[driver_street]","value":"Driver Street","type":"text"},{"key":"details[driver_town]","value":"Driver Town","type":"text"},{"key":"details[driver_postcode]","value":"Driver Postcode","type":"text"},{"key":"details[delivery_house_name_no]","value":"Delivery House Name Number","type":"text"},{"key":"details[delivery_postcode]","value":"Delivery Postcode","type":"text"},{"key":"details[delivery_street]","value":"Delivery Street","type":"text"},{"key":"details[delivery_town]","value":"Delivery Town","type":"text"},{"key":"details[collection_house_name_no]","value":"Collection House Name Number","type":"text"},{"key":"details[collection_postcode]","value":"Collection Postcode","type":"text"},{"key":"details[collection_street]","value":"Collection Street","type":"text"},{"key":"details[collection_town]","value":"Collection Town","type":"text"},{"key":"extras[1][id]","value":"123","type":"text"},{"key":"extras[1][qty]","value":"1","type":"text"},{"key":"extras[1][price]","value":"1","type":"text"},{"key":"extras[2][id]","value":"456","type":"text"},{"key":"extras[2][qty]","value":"2","type":"text"},{"key":"extras[2][price]","value":"2","type":"text"},{"key":"details[driver_title_1]","value":"Additional Driver Title","type":"text"},{"key":"details[driver_firstname_1]","value":"Additional Driver Firstname","type":"text"},{"key":"details[driver_surname_1]","value":"Additional Driver Surname","type":"text"},{"key":"details[driver_house_name_number_1]","value":"Additional Driver House Name / Number","type":"text"},{"key":"details[driver_street_1]","value":"Additional Driver Street","type":"text"},{"key":"details[driver_town_1]","value":"Additional Driver Town","type":"text"},{"key":"details[driver_postcode_1] ","value":"Additional Driver Postcode","type":"text"},{"key":"details[driver_dob_day_1]","value":"Additional Driver DOB Day","type":"text"},{"key":"details[driver_dob_month_1]","value":"Additional Driver DOB Month","type":"text"},{"key":"details[driver_dob_year_1]","value":"Additional Driver DOB Year","type":"text"},{"key":"details[driverslic_1]","value":"Additional Driver Licence Number","type":"text"},{"key":"details[natinsurance_1] = ''","value":"Additional Driver National Insurance Number","type":"text"}]},"url":"https://{{site_url}}.ivech.app/api/rental/add_booking","description":"This function is used to push a rental from your website / application into iVech. To do this, you need
to send your request containing an array of unique values.
This pushes the booking into a web bookings table, enabling the rental company to accept or decline the button. This is usually to give the rental company the ability to allocate the vehicle.
\n","urlObject":{"protocol":"https","path":["api","rental","add_booking"],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"da37d517-2dd4-496a-bf10-623bb7c5c459"},{"name":"Cancel Rental by Rental ID","id":"c99ac4c8-29d8-4e7e-a4ab-3a816537c68b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/cancel_rental_by_id?id=rental_id","description":"Can be used to cancel a previously created rental
\n","urlObject":{"protocol":"https","path":["api","cancel_rental_by_id"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"id","value":"rental_id"}],"variable":[]}},"response":[],"_postman_id":"c99ac4c8-29d8-4e7e-a4ab-3a816537c68b"},{"name":"Get the booking status of a rental","id":"86297566-b15c-4b67-9f79-7829a9df6e10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/get_rental_status_get?id=1","urlObject":{"protocol":"https","path":["api","get_rental_status_get"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"86297566-b15c-4b67-9f79-7829a9df6e10"},{"name":"Add Direct Booking","id":"bb8f60c4-1945-4537-a2f8-0375453e362a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"collection_date","value":"","type":"text"},{"key":"collection_time","value":"","type":"text"},{"key":"return_date","value":"","type":"text"},{"key":"return_time","value":"","type":"text"},{"key":"vehicle['vehicle_category]","value":"","type":"text"},{"key":"details['main_driver_house_name_no']","value":"","type":"text"},{"key":"details['main_driver_street']","value":"","type":"text"},{"key":"details['main_driver_town']","value":"","type":"text"},{"key":"details['main_driver_county']","value":"","type":"text"},{"key":"details['main_driver_postcode']","value":"","type":"text"},{"key":"details['title']","value":"","type":"text"},{"key":"details['firstname']","value":"","type":"text"},{"key":"details['lastname']","value":"","type":"text"},{"key":"details['company_name']","value":"","type":"text"},{"key":"details['main_driver_telephone_number']","value":"","type":"text"},{"key":"details['main_driver_additional_telephone_number']","value":"","type":"text"},{"key":"details['billing_email']","value":"","type":"text"},{"key":"details['type']","value":"","type":"text"},{"key":"hire_price","value":"","type":"text"},{"key":"vat_rate","value":"","type":"text"},{"key":"extras[1][id]","value":"123","type":"text"},{"key":"extras[1][qty]","value":"1","type":"text"},{"key":"extras[1][price]","value":"1","type":"text"},{"key":"extras[2][id]","value":"456","type":"text"},{"key":"extras[2][qty]","value":"2","type":"text"},{"key":"extras[2][price]","value":"2","type":"text"},{"key":"delivery_location_id","value":"","type":"text"}]},"url":"https://{{site_url}}.ivech.app/api/rental/add_direct_booking","description":"This is an important function which skips the web booking table in iVech. It will push a booking directly onto the rental direct. For that reason, you must have ran the vehicle availability calls to check for availability first.
\n","urlObject":{"protocol":"https","path":["api","rental","add_direct_booking"],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb8f60c4-1945-4537-a2f8-0375453e362a"}],"id":"47da6110-453f-4e27-bed0-2b24b6c11204","description":"These set of functions allow you to push full bookings into iVech through the API.
\n","_postman_id":"47da6110-453f-4e27-bed0-2b24b6c11204"},{"name":"Vehicle Categories","item":[{"name":"Get all vehicle categories","id":"8becc103-cf2c-424b-96d9-3b54ad096981","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/","description":"This returns all the standard vehicle categories setup within iVech.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category",""],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"8becc103-cf2c-424b-96d9-3b54ad096981"},{"name":"Get Descriptions, Extras and Images by website category name","id":"179d98b3-d016-4135-b4a6-f843f6231e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/return_by_website_category_name_with_all_info?website_category_name=car","description":"You can pass in a website category name and the function will return all the vehicle categories which belong within that website category.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","return_by_website_category_name_with_all_info"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"website_category_name","value":"car"}],"variable":[]}},"response":[],"_postman_id":"179d98b3-d016-4135-b4a6-f843f6231e59"},{"name":"Get Rental Extras","id":"106a3250-a21c-43c9-9d29-47fdccafe714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/extras","description":"This function is used to retrieve a list of all possible extras that can be used during the rental booking process
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","extras"],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"106a3250-a21c-43c9-9d29-47fdccafe714"},{"name":"Get rental extras by vehicle category","id":"6cf6b6a7-4ab3-4782-8e2c-fabc4a4b34bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/extras_by_vehicle_category_id?vehicle_category_id=5","description":"Within iVech, you can limit which rental extras are available on a per vehicle category basis. This is useful for things such as a sat nav which may be included in cars, but is an extra item for vans and minibuses. If you utilise this feature in iVech, its better to use this call rather than the standard get all extras function.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","extras_by_vehicle_category_id"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"vehicle_category_id","value":"5"}],"variable":[]}},"response":[],"_postman_id":"6cf6b6a7-4ab3-4782-8e2c-fabc4a4b34bd"},{"name":"Get Vehicle Category Extras, Specifications and Images","id":"9b56d881-7b4c-43a1-9cd3-b2e86d69828d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/description_extras_by_vehicle_category_id?vehicle_category_id=4","description":"This function is used to retrieve a list of all extras, specifications and images connected to a specific\nvehicle category.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","description_extras_by_vehicle_category_id"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"vehicle_category_id","value":"4"}],"variable":[]}},"response":[],"_postman_id":"9b56d881-7b4c-43a1-9cd3-b2e86d69828d"},{"name":"Get website category information","id":"92b3353d-248a-4321-af0e-e85139877000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/return_by_website_category_id?website_category_id=10","description":"Although vehicles are grouped by categories within iVech, you can group those categories by a web\ncategory, along the lines of Cars, Vans, Minibuses. This way you can pull all cars from the system\nusing this function
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","return_by_website_category_id"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"website_category_id","value":"10"}],"variable":[]}},"response":[],"_postman_id":"92b3353d-248a-4321-af0e-e85139877000"},{"name":"Get vehicle category information","id":"0581e0f5-6119-4b2d-8b5f-ac6feae5f885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/return_by_vehicle_category_id?vehicle_category_id=11","description":"Gets information based on a vehicle category ID. This includes the description and name.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","return_by_vehicle_category_id"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"vehicle_category_id","value":"11"}],"variable":[]}},"response":[],"_postman_id":"0581e0f5-6119-4b2d-8b5f-ac6feae5f885"},{"name":"Gets vehicle category information by the URL","id":"c8ef818d-b9dc-499a-ae6f-dc51bd6c1af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/return_by_vehicle_category_url_name?vehicle_category_url_name=luton","description":"Gets information based on a vehicle category URL. Response includes web category information too.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","return_by_vehicle_category_url_name"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"vehicle_category_url_name","value":"luton"}],"variable":[]}},"response":[],"_postman_id":"c8ef818d-b9dc-499a-ae6f-dc51bd6c1af8"}],"id":"927b7184-45cc-498a-b18c-4c196faf15e5","description":"This set of functions are based vehicles and their vehicle categories as defined in iVech. Categories can be setup in vehicle settings within iVech. Categories generally include things such as 'small cars', 'medium cars', 'short wheel base vans' etc...
\n","event":[{"listen":"prerequest","script":{"id":"993f8b40-9213-4448-832d-ad2a7766ea29","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59e7f650-32a5-44e7-8bbe-232a7e2e5f2e","type":"text/javascript","exec":[""]}}],"_postman_id":"927b7184-45cc-498a-b18c-4c196faf15e5"},{"name":"Web Categories","item":[{"name":"Get all website categories","id":"601e26e3-6448-4251-a0d6-0e6999b94abc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/web_category","description":"Returns a list of all website categories setup within iVech
\n","urlObject":{"protocol":"https","path":["api","web_category"],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"601e26e3-6448-4251-a0d6-0e6999b94abc"},{"name":"Return by URL Name","id":"72248295-5b1e-44e5-b026-89f38dceb207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/web_category/return_by_url_name?url_name=cars","description":"You can pass the web url name through this function to return the basic details about a website category.
\n","urlObject":{"protocol":"https","path":["api","web_category","return_by_url_name"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"url_name","value":"cars"}],"variable":[]}},"response":[],"_postman_id":"72248295-5b1e-44e5-b026-89f38dceb207"}],"id":"50df7a54-3bf0-44c2-8e03-754d360432ff","description":"Web Categories are an extra way to categorise vehicles within iVech. You can group multiple vehicle categories into a web category. For instance; small cars, medium cars and large cars could all be grouped into a website category. This will allow for pages to be created which display all the car categories available. You can manage web categories from within the website section of iVech.
\n","_postman_id":"50df7a54-3bf0-44c2-8e03-754d360432ff"},{"name":"Booking & Pricing","item":[{"name":"GET Price by Vehicle Category","id":"6cada402-219b-4f5f-b579-01dbf9c3ad99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/return_price?category_id=11&start_date=18-01-\n2017&end_date=20-01-2017&start_time=08:00&finish_time=08:00&days=2","description":"By posting dates and times, iVech will return the price of the particular vehicle category for that set period of time. Please note - this function will not generate correct prices until these have been setup by iVech suppoprt within the iVech rental system.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","return_price"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"category_id","value":"11"},{"key":"start_date","value":"18-01-\n2017"},{"key":"end_date","value":"20-01-2017"},{"key":"start_time","value":"08:00"},{"key":"finish_time","value":"08:00"},{"key":"days","value":"2"}],"variable":[]}},"response":[],"_postman_id":"6cada402-219b-4f5f-b579-01dbf9c3ad99"},{"name":"Check Discount Code","id":"a2fcadc3-7b37-4bde-a142-ba859930f732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/web_category/return_discount_code?discount_code=blackfriday20","description":"This function returns the details of discount code. If a code is now valid, or if the current date is not within the date range it will return an error. Discount / Voucher codes can be setup within the website section of iVech.
\n","urlObject":{"protocol":"https","path":["api","web_category","return_discount_code"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"discount_code","value":"blackfriday20"}],"variable":[]}},"response":[],"_postman_id":"a2fcadc3-7b37-4bde-a142-ba859930f732"},{"name":"Check vehicle category availability by ID","id":"5bafbb60-f38c-4392-87d1-439379a7fde7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle_category/check_vehicle_category_id_availability?vehicle_category_id=5&collection_date=04-12-2018&return_date=08-12-2018&collection_time=10:00&return_time=10:00","description":"This allows you to check the availability of any vehicle category. Useful for if you've turned off live availability and want to check on a per vehicle category basis during the booking process. Returns 'TRUE' if there is availaibility or 'FALSE' if there is not.
\n","urlObject":{"protocol":"https","path":["api","vehicle_category","check_vehicle_category_id_availability"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"vehicle_category_id","value":"5"},{"key":"collection_date","value":"04-12-2018"},{"key":"return_date","value":"08-12-2018"},{"key":"collection_time","value":"10:00"},{"key":"return_time","value":"10:00"}],"variable":[]}},"response":[],"_postman_id":"5bafbb60-f38c-4392-87d1-439379a7fde7"},{"name":"Get Preset Locations","id":"cd674ba5-f0ef-4af3-bb82-06b6835f136e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/branch/branch_preset_locations","description":"This returns all preset delivery / collection locations that have been setup in iVech.
\n","urlObject":{"protocol":"https","path":["api","branch","branch_preset_locations"],"host":["{{site_url}}","ivech","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd674ba5-f0ef-4af3-bb82-06b6835f136e"},{"name":"Check specific vehicle reg availability","id":"2d5646b0-3426-48d4-afcc-0b603a5ac86c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/vehicle/check_vehicle_reg?vehicle_reg=vehicle_reg&collection_date=22-07-2024&return_date=24-07-2024&collection_time=18:00&return_time=10:00","description":"Provide iVech with a vehicle registration (no spaces), dates and times. iVech will let you know if the vehicle is available for bookings or not.
\n","urlObject":{"protocol":"https","path":["api","vehicle","check_vehicle_reg"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"vehicle_reg","value":"vehicle_reg"},{"key":"collection_date","value":"22-07-2024"},{"key":"return_date","value":"24-07-2024"},{"key":"collection_time","value":"18:00"},{"key":"return_time","value":"10:00"}],"variable":[]}},"response":[],"_postman_id":"2d5646b0-3426-48d4-afcc-0b603a5ac86c"}],"id":"bbdc963f-a963-499d-a6bb-e6b5584118f9","description":"These functions are core to the rental process. Using these you can get prices and check availability of vehicles.
\n","_postman_id":"bbdc963f-a963-499d-a6bb-e6b5584118f9"},{"name":"Vehicles","item":[{"name":"Get vehicles for sale","id":"6f9781e4-cbef-4f6b-b9de-437a1494184a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"https://{{site_url}}.ivech.app/api/cancel_rental_by_id?id=rental_id","description":"Can be used to cancel a previously created rental
\n","urlObject":{"protocol":"https","path":["api","cancel_rental_by_id"],"host":["{{site_url}}","ivech","app"],"query":[{"key":"id","value":"rental_id"}],"variable":[]}},"response":[],"_postman_id":"6f9781e4-cbef-4f6b-b9de-437a1494184a"}],"id":"6e39dda2-de8d-4504-856f-6a64b30dab52","_postman_id":"6e39dda2-de8d-4504-856f-6a64b30dab52","description":""}],"event":[{"listen":"prerequest","script":{"id":"7a73921c-59ea-4816-b186-2405958cc902","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ee38e974-e9f1-46a6-8626-475b6808f272","type":"text/javascript","exec":[""]}}]}