ALOD APIs are designed to enable you to interact securely with our platform. You will get Base 64 encoded JSON responses from the API (same format will be followed in case of errors as well).
NOTE: You need to pass headers to access all api's.
Headers: authkey : {ACCESS KEY}
Param name - authkey: Access Key of business account. This will be provided to you by our support team.
Also our support team provide you user_id which you have to pass in all required places while requesting.
Merchant URL : https://www.alod.net/mobile_api
Name | Description | Note |
---|---|---|
Method ( required ) |
Call Method Name of function | String |
Model ( required ) |
Call Model Name of function | String |
{ "status":"success", "_method_name":"METHOD_NAME", "_model_name":"MODEL_NAME" "message":"SUCCESS_MESSAGE", }
{ "status":"error", "errors":[{"param":"PARAM_NAME","msg":"ERROR_MESSAGE","value":"PARAM_VALUE"}] }
Use: This function is used to get all Vehicle list of business.
Name | Values | Description |
---|---|---|
Method ( required ) |
getAllVehicleListOfBusiness | Fix value |
Model ( required ) |
business_booking | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
{ "status":"success", "vehicle_list":[ {"_id":"61643ede0f70e2175deee367","name":"Mini Truck"}, {"_id":"61643ede0f70e2175deee36b","name":"Van"}, {"_id":"61643ede0f70e2175deee36d","name":"Bike"}, {"_id":"61643ede0f70e2175deee36f","name":"Car"}, ], "_method_name":"getAllVehicleListOfBusiness", "_model_name":"business_booking" }
Use: This function is used to create multiple bookings.
Name | Values | Description |
---|---|---|
Method ( required ) |
createBooking | Fix value |
Model ( required ) |
business_booking | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
merchant_id | Example : 215349459 | Merchant id of business which is your system unique id. |
user_type ( required ) |
business | Fix value |
booking_detail (required) |
[ { "pickup_latitude":"30.51956649", "pickup_longitude":"44.49629547", "pickup_country_code":"SA", "pickup_address":"GF9W+RG Al Salman, Iraq", "dropoff_address":"829G+46X, Jabriya, Kuwait", "dropoff_latitude":"29.31800973", "dropoff_longitude":"48.02595257", "dropoff_country_code":"SA", "booking_type" : "pallet/container", "pallet_container_id" : "5f462ff416a42d7a028348d8", "stakeholder_name": 'Test 1', "country_code": '+966', "stakeholders":"123123123", "imported_order_id":"12345" "item_name":"Television", "quantity":"2", "item_weight":10, "item_detail":" Television", "item_quantity":10, "item_price":111, "stackable" : "0/1", "insurance" : "0/1, "payment_type":ppd / cod, "is_international": "1", "cod_amount":100, "schedule_type":'schedule_now/schedule_later', "scheduled_time":"", "delivery_partners": 'ups/dhl/alod/shipa', "length": '', "width": '', "height": '' , "vehicle_type":"5f462ff416a42d7a028348d8", "is_location_unknown":"true", "is_invoice_required" : "0/1", }, { "pickup_latitude":"30.51956649", "pickup_longitude":"44.49629547", "pickup_country_code":"SA", "pickup_address":"GF9W+RG Al Salman, Iraq", "dropoff_address":"829G+46X, Jabriya, Kuwait", "dropoff_latitude":"29.31800973", "dropoff_longitude":"48.02595257", "dropoff_country_code":"SA", "booking_type" : "pallet/container", "pallet_container_id" : "5f462ff416a42d7a028348d8", "stakeholder_name": 'Test 1', "country_code": '+966', "stakeholders":"123123123", "imported_order_id":"12345" "item_name":"Television", "quantity":"2", "item_weight":10, "item_detail":" Television", "item_quantity":10, "item_price":111, "stackable" : "0/1", "insurance" : "0/1, "payment_type":ppd / cod, "is_international": "1", "cod_amount":100, "schedule_type":'schedule_now/schedule_later', "scheduled_time":"", "delivery_partners": 'ups/dhl/alod/shipa', "length": '', "width": '', "height": '' , "vehicle_type":"5f462ff416a42d7a028348d8", "is_location_unknown":"true", "is_invoice_required" : "0/1", } ] |
Multiple booking item details
|
item_images |
{ 'item_images[0][0]': { name: 'blog-02.png', data: |
Multiple Item Images of booking. |
packaging |
{ 'packaging[0][0]': { name: 'blog-02.png', data: |
Packaging Images for booking. |
Invoice (required if booking is international and is_invoice_required is 1 ) |
{ 'invoice[0][0]': { name: '1657099691277-bookings.pdf', data: |
Upload invoice PDF if booking is international. |
NOTE:
1)Parcel:
a)Domestic: All the delivery partner will be shown.
b)International Import - All around the world DHL & UPS.
If Pick up country will be UAE then shipa will be there.
c)Export: DHL & UPS worldwide
If the Export country will be Kuwait & UAE then shipa will also appear.
Note: Shipa is importing from UAE only and Exporting to Kuwait & UAE.
2) Pallet:
a)Domestic: All the delivery partners will show
b)International: UPS, SHIPA and DHL will be shown in import and export
Note: Shipa is importing from UAE Only and Exporting to Kuwait & UAE.
3) Container:
a)Domestic: All the delivery partners will show
b)International: UPS, SHIPA and DHL will be shown in import and export
Note: Shipa is importing from UAE Only and Exporting to Kuwait & UAE.
{ "status":"success", "booking_ids":["618e35b89b7f4f5bbf715464"], "message":"Booking has been scheduled successfully.", "_method_name":"createBooking", "_model_name":"business_booking" }
{ "status":"error", "message":[ {"param":"booking_detail_0_item_name","msg":"Please enter item name."}, {"param":"item_images_0","msg":"Please select images."} ], "req_files":null, "_method_name":"createBooking", "_model_name":"business_booking" }
Use: This function is used to check total no of booking available for the selected vehicle type.
Name | Values | Description |
---|---|---|
Method ( required ) |
checkBookingStatus | Fix value |
Model ( required ) |
business_booking | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
no_of_booking ( required ) |
5 | No. of bookings you want to add |
vehicle_type ( required ) |
Example : 5f462ff416a42d7a028348d8 | Vehicle id of selected vehicle type for booking (received from vehicle list API) |
{ "status":"success", "message":"Total available booking for this vehicle type is 2", "_method_name":"checkBookingStatus", "_model_name":"business_booking" }
{ "status":"error", "message":"Total available booking for this vehicle type is 2", "_method_name":"checkBookingStatus", "_model_name":"business_booking" }
Use: This function is used to get booking list.
Name | Values | Description |
---|---|---|
Method ( required ) |
bookingListing | Fix value |
Model ( required ) |
booking | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
limit | 10 | No. of record you want to show on listing page. |
skip | 0 | Total record skip (along with limit) |
user_type (required) |
business | Fix value |
Success:{ "status":"success", "result":[ { "_id":"618e35b89b7f4f5bbf715464", "user_id":"612dd73727bc7336d71d8f85", "booking_distance":568, "booking_duration":346, "booking_id":"786853", "bulk_booking_id":"618e35b89b7f4f5bbf715463", "business_booking":true, "cancelled_time":"2021-11-12T09:44:56.625Z", "created":"2021-11-12T09:36:56.626Z", "dropoff_details":{ "dropoff_city":"الجابرية", "dropoff_area":"الجابرية", "dropoff_country":"الكويت", "dropoff_address":"829G+46X, Jabriya, Kuwait", "dropoff_latitude":29.31800973, "dropoff_longitude":48.02595257, "dropoff_lng_city":["الجابرية","jabriya"], "dropoff_lng_area":["الجابرية",""], "dropoff_lng_country":["الكويت","kuwait"] }, "is_location_unknown":false, "items_list":[ { "_id":"618e35b89b7f4f5bbf715465", "item_name":"etertert", "item_details":"sdgdfgdf", "total_volume":0, "category":"", "quantity":2, "images":[], "volume":0, "dimensions":{"height":0,"width":0,"length":0}, "category_name":"" }], "labors":2, "modified":"2021-11-12T09:36:56.625Z", "payment_details":{"payment_type":"online"}, "payout_details":{"system_payout":123}, "pickup_details":{"pickup_address":"GF9W+RG Al Salman, Iraq","pickup_latitude":30.51956649,"pickup_longitude":44.49629547,"pickup_city":"السلمان","pickup_area":"السلمان","pickup_country":"العراق","pickup_lng_city":["السلمان","al salman"],"pickup_lng_area":["السلمان",""],"pickup_lng_country":["العراق","iraq"]}, "stakeholder_ids":["61518afea9505a14e13e3fc9"], "status":"placed", "user_type":"business", "vehicle_type":"motorcycle", "vehicle_type_id":"5f462ff416a42d7a028348d8", "zoon_shipment":"regular", "zoon_slug":"zoon_three", "vehicle_type_details":{"icon":"JAN2021/1610023980224-bike3x.png","name":"Bike"}, "customer_name":"Business 1 B1", "customer_image":"SEP2021/1632137222448-1623399634603ubericon.png", "customer_mobile_number":"+9667777777771" } ], "total_records":3, "user_image_path":"https://www.alod.net/public/frontend/uploads/user/", "booking_image_path":"https://www.alod.net/public/frontend/uploads/booking/", "vehicle_image_path":"https://www.alod.net/public/frontend/uploads/vehicle_category/", "_method_name":"bookingListing", "_model_name":"booking" }
Use: This function is used to get assign vehicle list with other details.
Name | Values | Description |
---|---|---|
Method ( required ) |
getBusinessVehicleDetails | Fix value |
Model ( required ) |
vehicles | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
{ "status":"success", "data":[ {"_id":"61643ede0f70e2175deee367","amount":11,"capacity":3,"no_of_vehicle":3,"name":"Mini Truck"}, {"_id":"61643ede0f70e2175deee36b","amount":50,"capacity":5,"no_of_vehicle":5,"name":"Van"}, {"_id":"61643ede0f70e2175deee36d","amount":123,"capacity":2,"no_of_vehicle":2,"name":"Bike"}, {"_id":"61643ede0f70e2175deee36f","amount":22,"capacity":2,"no_of_vehicle":2,"name":"Car"}, ], "recordsTotal":6, "recordsFiltered":6, "_method_name":"getBusinessVehicleDetails", "_model_name":"vehicles" }
Use: This function is used to get notification list of business.
Name | Values | Description |
---|---|---|
Method ( required ) |
getNotifications | Fix value |
Model ( required ) |
notification | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
limit | 10 | No. of record you want to show on listing page. |
skip | 0 | Total record skip (along with limit) |
{"status":"success","result":[],"recordsTotal":5,"recordsSkipTotal":5,"limit":10,"_method_name":"getNotifications","_model_name":"notification"}
Use: This function is used to get booking pay-out report.
Name | Values | Description |
---|---|---|
Method ( required ) |
getBusinessPayoutList | Fix value |
Model ( required ) |
business_booking | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
limit | 10 | No. of record you want to show on listing page. |
skip | 0 | Total record skip (along with limit) |
{"status":"success","result":[],"recordsTotal":3,"recordsSkipTotal":3,"limit":10,"_method_name":"getBusinessPayoutList","_model_name":"business_booking"}
Use: This function is used to get booking detail of business.
Name | Values | Description |
---|---|---|
Method ( required ) |
getBookingDetails | Fix value |
Model ( required ) |
booking | Fix value |
user_id ( required ) |
Example : 61559a7e1d3f24416428a6c1 | User Id of business account |
booking_id (required) |
Example : 620dce6cbeb0ec438274dd74 | Booking Id of business booking |
user_type (required) |
Business | Fix value |
{ "status":"success", "result":{ "_id":"620dce6cbeb0ec438274dd74", "user_id":"61559a7e1d3f24416428a6c1", "booking_distance":2, "booking_duration":6, "booking_id":"404444", "bulk_booking_id":"620dce6cbeb0ec438274dd73", "business_booking":true, "created":"2022-02-28T04:23:00.000Z", "created_on":"2022-02-17T04:26:21.968Z", "dropoff_details":{ "dropoff_city":"jaipur", "dropoff_area":"gopalbari", "dropoff_country":"india", "dropoff_address":"Jaipur Junction, Station Road, Gopalbari, Jaipur, Rajasthan, India", "dropoff_latitude":26.9195875, "dropoff_longitude":75.78796080000001, "dropoff_lng_city":[ "jaipur", "jaipur" ], "dropoff_lng_area":[ "gopalbari", "" ], "dropoff_lng_country":[ "india", "india" ] }, "is_location_unknown":false, "is_scheduled":true, "items_list":[ { "_id":"620dce6dbeb0ec438274dd77", "item_name":"item name", "item_details":"sfsfsdf", "total_volume":0, "category":"", "quantity":1, "images":[ { "_id":"620dce6dbeb0ec438274dd75", "image":"FEB2022/1645071981467-blog01.png" } ], "volume":0, "dimensions":{ "height":0, "width":0, "length":0 }, "category_name":"" } ], "modified":"2022-03-08T09:42:02.313Z", "no_of_packages":1, "package_barcodes":[ { "code":"518559" } ], "payment_details":{ "cod_amount":"", "payment_type":"online" }, "payout_details":{ "system_payout":50 }, "pickup_details":{ "pickup_address":"Jaipur, Rajasthan, India", "pickup_latitude":26.9124336, "pickup_longitude":75.7872709, "pickup_city":"jaipur", "pickup_area":"ganpati nagar", "pickup_country":"india", "pickup_lng_city":[ "jaipur", "jaipur" ], "pickup_lng_area":[ "ganpati nagar", "" ], "pickup_lng_country":[ "india", "india" ] }, "stakeholder_ids":[ ], "status":"timeout", "user_type":"business", "vehicle_type":"motorcycle", "vehicle_type_id":"5f46266ea621fb50c3a19eba", "zoon_shipment":"regular", "zoon_slug":"zoon_one", "user_mobile_number":"+966111111111", "user_name":"Test api", "api_type":"alod", "current_driver_details":null, "ratings":{ }, "vehicle_type_details":{ "icon":"JAN2021/1611309394930-largetruck3x.png", "name":"Mini Truck", "vehicle_maker":"JAN2021/1611309437149-largetruckmark3x.png" }, "customer_name":"Test api", "customer_image":"MAR2022/1648112334623-zkOHn2Yv.png", "customer_rating":3, "customer_mobile_number":"+966111111111", "stackholder_list":[ { "mobile_number":"1010101010", "stakeholder_name":"" } ], "qr_codes":[ { "_id":"620dce6dbeb0ec438274dd76", "barcode":"1645071981674518559_qrcode.png", "full_image_path":"https://www.alod.net/public/frontend/uploads/barcode/1645071981674518559_qrcode.png" } ] }, "image_path":"https://www.alod.net/public/frontend/uploads/user/", "booking_image_path":"https://www.alod.net/public/frontend/uploads/booking/", "vehicel_image_path":"https://www.alod.net/public/frontend/uploads/vehicle_category/", "booking_invoice_url":"https://www.alod.net/public/frontend/uploads/booking_invoice/", "booking_ups_item_list":[ ], "ups_image_path":"https://www.alod.net/public/frontend/uploads/ups_label/", "_method_name":"getBookingDetails", "_model_name":"booking" }
Use: This function is used to get all pricing for business.
Name | Values | Description |
---|---|---|
Method ( required ) |
getWeightPriceLists | Fix value |
Model ( required ) |
booking | Fix value |
user_id ( required ) |
Example : 0 | Type 0 for business pricing |
NOTE:
{ "status":"success", "ups_pricing":[ { "_id":"623bea24bf6a8a1a7a06caf3", "max":15, "min":0, "price":20 }, { "_id":"623bea38ac8872633f1ff303", "max":30, "min":15, "price":47.75 }, { "_id":"623bea4abf6a8a1a7a06caf4", "max":45, "min":30, "price":75.5 }, { "_id":"623bea63ac8872633f1ff304", "max":"", "min":45, "price":1.85 } ], "alod_pricing":null, "_method_name":"getWeightPriceLists", "_model_name":"booking" }
Use: This function is used to get all pricings.
Name | Values | Description |
---|---|---|
Method ( required ) |
getWeightPriceLists | Fix value |
Model ( required ) |
booking | Fix value |
Type ( required ) |
Example : 1 | Type 1 for business pricing |
NOTE:
There are 2 shipping pricing are available
Max and Min values are item weight. If item weight varies between the min and max value, then the mentioned price will apply. If item weight is greater than 45 kg then price will increase per KG like weight is 47 KG then 45 kg cost will be 75.5 and extra 2 kg will calculate like 2 * 1.85.
Alod Pricingdepends on vehicle type (like sedan car), zone and on item size. The min and max values are kilometres.
{ { "status":"success", "ups_pricing":[ { "_id":"623b142b23771e1773264c85", "max":15, "min":0, "price":60 }, { "_id":"623b142b23771e1773264c87", "max":30, "min":15, "price":116.25 }, { "_id":"623b142b23771e1773264c8a", "max":45, "min":30, "price":172.5 }, { "_id":"623b142b23771e1773264c8c", "max":"", "min":45, "price":3.75 } ], "alod_pricing":{ "Sedan Car":{ "Zone 1":{ "regular":[ { "labour_cost":0, "max":20, "min":0, "perkm":5 }, { "labour_cost":0, "max":30, "min":20, "perkm":1.7 }, { "labour_cost":0, "max":40, "min":30, "perkm":1.7 }, { "labour_cost":0, "max":50, "min":40, "perkm":1.7 } ], "large":[ { "labour_cost":70, "max":20, "min":0, "perkm":6.7 }, { "labour_cost":70, "max":30, "min":20, "perkm":0 }, { "labour_cost":70, "max":40, "min":30, "perkm":4.77 }, { "labour_cost":70, "max":50, "min":40, "perkm":4 } ] }, "Zone 2":{ "regular":[ { "labour_cost":0, "max":150, "min":51, "perkm":1.05 }, { "labour_cost":0, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":0, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":0, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":6, "max":1200, "min":901, "perkm":0.2 } ], "large":[ { "labour_cost":100, "max":150, "min":51, "perkm":1 }, { "labour_cost":100, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":100, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":100, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":100, "max":1200, "min":901, "perkm":0.3 } ] }, "Zone 3":{ "regular":[ { "labour_cost":0, "perkm":0.6 }, { "labour_cost":0, "perkm":0.6 } ], "large":[ { "labour_cost":100, "perkm":0.6 }, { "labour_cost":100, "perkm":0.6 } ] }, "Zone 4":{ "regular":[ { "labour_cost":0, "perkm":26.2 } ], "large":[ { "labour_cost":100, "perkm":17 } ] } }, "SUV Car":{ "Zone 1":{ "regular":[ { "labour_cost":5, "max":5000000, "min":0, "perkm":1.7 }, { "labour_cost":0, "max":30, "min":20, "perkm":1.7 }, { "labour_cost":0, "max":40, "min":30, "perkm":1.7 }, { "labour_cost":0, "max":5000, "min":40, "perkm":1.7 } ], "large":[ { "labour_cost":70, "max":20, "min":0, "perkm":6.7 }, { "labour_cost":70, "max":30, "min":20, "perkm":4.9 }, { "labour_cost":70, "max":40, "min":30, "perkm":4.77 }, { "labour_cost":70, "max":5000, "min":40, "perkm":4 } ] }, "Zone 2":{ "regular":[ { "labour_cost":0, "max":150, "min":50, "perkm":0.98 }, { "labour_cost":0, "max":300, "min":151, "perkm":0.5 }, { "labour_cost":0, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":0, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":5, "max":1200, "min":901, "perkm":0.2 } ], "large":[ { "labour_cost":100, "max":150, "min":50, "perkm":1 }, { "labour_cost":100, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":100, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":100, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":100, "max":1200, "min":901, "perkm":0.3 } ] }, "Zone 3":{ "regular":[ { "labour_cost":0, "perkm":0.6 } ], "large":[ { "labour_cost":100, "perkm":0.6 } ] }, "Zone 4":{ "regular":[ { "labour_cost":0, "perkm":26.2 } ], "large":[ { "labour_cost":100, "perkm":17 } ] } }, "Cold Trucks":{ "Zone 1":{ "regular":[ { "labour_cost":0, "max":20, "min":10, "perkm":1.7 }, { "labour_cost":0, "max":30, "min":20, "perkm":1.7 }, { "labour_cost":0, "max":40, "min":30, "perkm":1.7 }, { "labour_cost":0, "max":50, "min":40, "perkm":1.7 } ], "large":[ { "labour_cost":70, "max":20, "min":10, "perkm":6.7 }, { "labour_cost":70, "max":30, "min":20, "perkm":4.9 }, { "labour_cost":70, "max":40, "min":30, "perkm":4.77 }, { "labour_cost":70, "max":50, "min":40, "perkm":4 } ] }, "Zone 2":{ "regular":[ { "labour_cost":0, "max":150, "min":51, "perkm":0.98 }, { "labour_cost":0, "max":300, "min":151, "perkm":0.5 }, { "labour_cost":0, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":0, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":0, "max":1200, "min":901, "perkm":0.2 } ], "large":[ { "labour_cost":100, "max":150, "min":51, "perkm":1 }, { "labour_cost":100, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":100, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":100, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":100, "max":1200, "min":901, "perkm":0.3 } ] }, "Zone 3":{ "regular":[ { "labour_cost":0, "perkm":0.15 } ], "large":[ { "labour_cost":100, "perkm":0.2 } ] }, "Zone 4":{ "regular":[ { "labour_cost":0, "perkm":0.13 } ], "large":[ { "labour_cost":100, "perkm":0.2 } ] } }, "Mini Truck":{ "Zone 1":{ "regular":[ { "labour_cost":0, "max":20, "min":1, "perkm":1.7 }, { "labour_cost":0, "max":30, "min":20, "perkm":1.7 }, { "labour_cost":0, "max":40, "min":30, "perkm":1.7 }, { "labour_cost":0, "max":50, "min":40, "perkm":1.7 } ], "large":[ { "labour_cost":70, "max":20, "min":1, "perkm":6.7 }, { "labour_cost":70, "max":30, "min":20, "perkm":0 }, { "labour_cost":70, "max":40, "min":30, "perkm":4.77 }, { "labour_cost":70, "max":50, "min":40, "perkm":4 } ] }, "Zone 2":{ "regular":[ { "labour_cost":0, "max":150, "min":51, "perkm":1.05 }, { "labour_cost":0, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":0, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":0, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":0, "max":1200, "min":901, "perkm":0.2 } ], "large":[ { "labour_cost":0, "max":150, "min":51, "perkm":1 }, { "labour_cost":100, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":100, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":100, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":100, "max":1200, "min":901, "perkm":0.3 } ] }, "Zone 3":{ "regular":[ { "labour_cost":0, "perkm":0.6 } ], "large":[ { "labour_cost":100, "perkm":0.6 } ] }, "Zone 4":{ "regular":[ { "labour_cost":0, "perkm":26.2 } ], "large":[ { "labour_cost":100, "perkm":17 } ] } }, "Tow Truck":{ "Zone 1":{ "regular":[ { "labour_cost":0, "max":20, "min":1, "perkm":1.7 }, { "labour_cost":0, "max":30, "min":20, "perkm":1.7 }, { "labour_cost":0, "max":40, "min":30, "perkm":1.7 }, { "labour_cost":0, "max":50, "min":40, "perkm":1.7 } ], "large":[ { "labour_cost":70, "max":20, "min":10, "perkm":6.7 }, { "labour_cost":70, "max":30, "min":20, "perkm":4.9 }, { "labour_cost":70, "max":40, "min":30, "perkm":4.77 }, { "labour_cost":70, "max":50, "min":40, "perkm":4 } ] }, "Zone 2":{ "regular":[ { "labour_cost":0, "max":150, "min":51, "perkm":0.98 }, { "labour_cost":0, "max":300, "min":151, "perkm":0.5 }, { "labour_cost":0, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":0, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":0, "max":1200, "min":901, "perkm":0.2 } ], "large":[ { "labour_cost":100, "max":150, "min":51, "perkm":1 }, { "labour_cost":100, "max":300, "min":151, "perkm":0.55 }, { "labour_cost":100, "max":600, "min":301, "perkm":0.3 }, { "labour_cost":100, "max":900, "min":601, "perkm":0.2 }, { "labour_cost":100, "max":1200, "min":901, "perkm":0.3 } ] }, "Zone 3":{ "regular":[ { "labour_cost":0, "perkm":0.15 } ], "large":[ { "labour_cost":100, "perkm":0.2 }, { "labour_cost":100, "perkm":0.2 } ] }, "Zone 4":{ "regular":[ { "labour_cost":0, "perkm":0.13 }, { "labour_cost":0, "perkm":0.13 } ], "large":[ { "labour_cost":100, "perkm":0.2 } ] } }, "Van":{ "Zone 1":{ "regular":[ { "labour_cost":0, "max":1000, "min":0, "perkm":2 } ] } } }, "_method_name":"getWeightPriceLists", "_model_name":"booking" } }
Use:This function is used to track a particular booking
Request Parameters :
Name | Values | Description |
---|---|---|
Method ( required ) |
getTrackingDetails | Fix value |
Model ( required ) |
business_booking | Fix value |
booking_id (required) |
Example : 625fe47c6b8812713f16c52a | Booking Id of business booking |
{ If booking is scheduled with Alod Delivery:{ "status":"success", "booking_status":"delivered", "booking_type":"alod", "booking_status_details":[ { "_id":"6257dcd023771e17733a59df", "status":"Delivered", "created":"2022-04-14T08:35:28.529Z" }, { "_id":"6257dcc023771e17733a58af", "status":"Reached Receiver", "created":"2022-04-14T08:35:12.694Z" }, { "_id":"6257dcb223771e17733a56de", "status":"Arrived to Collect the Shipment", "created":"2022-04-14T08:34:58.989Z" }, { "_id":"6257d8c723771e177339fa41", "status":"Sent to Carrier", "created":"2022-04-14T08:18:15.605Z" }, { "_id":"6257d8b523771e177339f852", "status":"Shipment Submitted", "created":"2022-04-14T08:17:57.654Z" } ], "_method_name":"getTrackingDetails", "_model_name":"business_booking" } If booking is scheduled with UPS Delivery:{ "status":"success", "booking_status":"delivered", "booking_type":"ups", "booking_status_details":[ { "location":{ "address":{ "city":"", "stateProvince":"", "postalCode":"", "country":"SA" } }, "status":{ "type":"MV", "description":"Shipment Cancelled", "code":"VP" }, "date":"20220419", "time":"155720" }, { "location":{ "address":{ "city":"", "stateProvince":"", "postalCode":"", "country":"SA" } }, "status":{ "type":"M", "description":"Shipper created a label, UPS has not received the packageyet.", "code":"MP" }, "date":"20220419", "time":"155215" } ], "_method_name":"getTrackingDetails", "_model_name":"business_booking" } }
Use: This function is used to get all pallet/container data.
Name | Values | Description |
---|---|---|
Method ( required ) |
getPalletContainerData | Fix value |
Model ( required ) |
booking | Fix value |
Type ( required ) |
Example: "pallet/container" |
Fix value |
{ "status":"success", "result":[{ "_id":"630f2ba32528bc2d8c4e6f73","type":"container","container_size":"FC","container_type":"20’ Standard","max_load":"28,210 kg","max_volume":"33.2 cbm","max_pallets":"9-11","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2c02256e4c148d1bf7b2","type":"container","container_size":"FC","container_type":"40’ Standard","max_load":"26,780 kg","max_volume":"67.6 cbm","max_pallets":"20-21","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2d7038dd4b7b292cac53","type":"container","container_size":"HC","container_type":"40’ Standard","max_load":"26,590 kg","max_volume":"76.3 cbm","max_pallets":"23-24","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2dad0f9a6102c62b70f2","type":"container","container_size":"FC","container_type":"45’ Standard","max_load":"27,860 kg","max_volume":"86 cbm","max_pallets":"24-27","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2df5d07fb748da75a1f4","type":"container","container_size":"FC","container_type":"20’ Reefer","max_load":"27,400 kg","max_volume":"28.3 cbm","max_pallets":"9-10","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2e202528bc2d8c4e6f74","type":"container","container_size":"FC","container_type":"40’ Reefer","max_load":"27,700 kg","max_volume":"59.3 cbm","max_pallets":"20","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2e5bba92120b984ffd84","type":"container","container_size":"HC","container_type":"40’ Reefer","max_load":"29,520 kg","max_volume":"67.3 cbm","max_pallets":"20-23","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1}, {"_id":"630f2f7fba92120b984ffd85","type":"container","container_size":"FC","container_type":"45’ Reefer","max_load":"29,150 kg","max_volume":"67 cbm","max_pallets":"26-30","created":"2022-08-31T09:59:41.317Z","modified":"2022-08-31T09:59:41.317Z","status":1} ], "_method_name":"getPalletContainerData","_model_name":"booking" }
Use: This function is used to get Airwaybill Label from booking id.
Name | Values | Description |
---|---|---|
Method ( required ) |
getAwbLinks | Fix value |
Model ( required ) |
booking | Fix value |
booking_id ( required ) |
Example : 633fc33b82eae94a8817fcb7 | Booking Id of business booking |
{ "status":"success", "result":[ { "_id":"633fc37fe4152efb029214af", "shipment_label_pdf":"https://www.alod.net/public/frontend/uploads/ups_label/1665123194654_0_shipment_label.PDF" }, { "_id":"633fc37fe4152efb029214b0", "shipment_label_pdf":"https://www.alod.net/public/frontend/uploads/ups_label/1665123198701_1_shipment_label.PDF" }], "_method_name":"getAwbLinks", "_model_name":"booking" }
Use: This function is used to onboard merchant of business in alod system.
Name | Values | Description |
---|---|---|
Method ( required ) |
merchantOnboard | Fix value |
Model ( required ) |
business_booking | Fix value |
business_id ( required ) |
Example : 61559a7e1d3f24416428a6c6 | Business id of business account which is provided by our support team. |
merchant_id ( required ) |
Example : 215349459 | Merchant id of business which is your system unique id. |
merchant_name ( required ) |
Example : Demo | Merchant name of business |
merchant_email ( required ) |
Example : xyz@mailinator.com | Merchant email of business |
merchant_mobile ( required ) |
Example : +966511111111 | Merchant mobile of business |
merchant_location | Example : Riyadh Front - Shopping Area, Airport Road, Riyadh Saudi Arabia | Merchant location of business |
{ "status":"success", "message":"Merchant detail has been added successfully.", "_method_name":"merchantOnboard", "_model_name":"business_booking" }