all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getDeliveryVehicles
Human Readable Name or Caption:
Get Delivery Vehicles
Page/Function Description:
This method will get delivery vehicle data.
Page/Function Output Type:
API - JSON or WDDX
Categories:
invoice,customer
Extra Page/Function Notes:
This method will get delivery vehicle data if the delivery option is set up.


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_ID Numeric 0 Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
QRY_DELIVERY_VEHICLE_INFO_ARRAY Array This is the query result for the main delivery vehicle details. This result set will include things such as: license plate, make, model name, status and vehicle id.
LICENSE_PLATE String This is the license plate. This is the vehicle license plate number (example: V57 6AE).
MAKE String This is the vehicle make. This is the vehicle make (example: Toyota).
MODEL String This is the vehicle model. This is the vehicle model (example: Camry).
NAME String This is the vehicle name. This is the vehicle name given to identify the specific vehicle (example: Blue Camry or Toyota #2).
STATUS Numeric This is the vehicle status. This is the vehicle status (example: 1 = Active, 2 = Inactive).
VEHICLE_ID String This is the vehicle id. This is the vehicle identification number. It is auto assigned within adilas (from1 to the number of vehicles, example: 5).


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getDeliveryVehicles","CORP_ID":53,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}