courierhome api
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md

README.md

Appendix

  1. API request for shipment rate.
  2. API request for create shipment
  3. API request for tracking order.
  4. API request for pickup number.

Test Keys
App ID: CHWEBAPP171029095036
Keys: C913CC2948CF17406040F2C525E738A

API Request for Shipment Rate

Note: URL Method has to be POST
URL: https://www.courierhome.com/apiservices/courier_rate

Following parameters (all in small letter ) needs to be posted:

appid : *******
key : ******
from_pincode : (pickup pincode) e.g. 110025
to_pincode : (destination pincode) e.g. 110025
weight : (in Kg) e.g 1
height : (in cm)
length : (in cm)
width : (in cm)
shipment_type : (Prepaid or COD)
courier_type : document or parcel

Json Response
{ "response":"Success", "rate_req_id":14, "result":[ { "courier_name":"aramex", "from_pincode":"302021", "to_pincode":"302034", "image":"https://courierhome.com/assets/image/aramex.png", "weight":"2", "type":"Prepaid", "height":"4", "length":"3", "width":"2", "base_price":123, "fuel":46, "weight_price":"", "rto":"", "dto":"", "service_tax":34, "expected_pickup_time":"5 PM", "expected_pickup_date":"November 7, 2017", "delivary_date":"November 11, 2017", "total_amount":203 }, { "courier_name":"delhivery", "from_pincode":"302021", "image":"https://courierhome.com/assets/image/delhivery.png", "to_pincode":"302034", "weight":"2", "type":"Prepaid", "height":"4", "length":"3", "width":"2", "base_price":189, "fuel":95, "weight_price":150, "rto":150, "dto":280, "service_tax":49, "expected_pickup_time":"1 PM", "expected_pickup_date":"November 7, 2017", "delivary_date":"November 11, 2017", "total_amount":333 } ] }

API Request for Create Shipment

Note: URL Method has to be POST
URL: https://www.courierhome.com/apiservices/create_shipment_demo

Following parameters (all in small letter ) needs to be posted:

appid : *******
key : ******
courier_name: courier name from rate api
rate_req_id : rate request id from rate api
order_no : unique no to trace date
amount : rate api response (total_amount) parameter
sender_name : test
sender_email : sender email address (optional )
sender_phone : 1234567890 ( courier sender person phone no )
sender_address : test 1234 Delhi (courier pickup address)
sender_city : Delhi ( pickup city)
sender_state: Delhi ( pickup state)
sender_zipcode : 110025 (sender pickup pincode rate api (from_pincode) )
receiver_name : test (courier receiver name )
receiver_email : receiver email
receiver_phone : 1234567890 ( courier receiver person phone no )
receiver_address : test 1234 Jaipur (courier pickup address)
receiver_city : Jaipur
receiver_state : Rajasthan (courier receiver State )
receiver_zipcode : 110025 (sender pickup pincode rate api (to_pincode)
courier_type : document or parcel
shipment_type : (Prepaid or COD)
item_decription : product description
item_value : product value eg 1000
cod_value : 1000 (collectable price for COD shipment type , for prepaid 0 )
quantity : 1
weight : (in Kg) e.g 1
height : (in cm) 10
length : (in cm) 10
width : (in cm) 10

Response
{ "response":"Success", "result":[ { "order_no":"123456789", "awb_number":"12345678", "amount":"100", "pickup_no":"12345678", "pdf_url":"https://courierhome.com/delhivery/demo.pdf" } ] }

API Request for Track Shipment

Note: URL Method has to be POST
URL: https://www.courierhome.com/apiservices/track_shipment

Following parameters (all in small letter ) needs to be posted:

appid : *******
key : ******
awb_number:2068724722
courier_name : aramex (holisol, delhivery, aramex, fedex_priority, fedex_economy)

Json response
{ "response":"Success", "result":[ { "UpdateDescription":"Delivered", "UpdateDateTime":"2017-11-03T15:56:00", "UpdateLocation":"Azadpur, India" }, { "UpdateDescription":"SMS Sent to Consignee", "UpdateDateTime":"2017-11-03T09:09:00", "UpdateLocation":"Gurgaon, India" } ] }

API Request for Pickup Request

Note: URL Method has to be POST
URL: https://www.courierhome.com/apiservices/pickup_request

Following parameters (all in small letter ) needs to be posted:

appid : *******
key : ******
order_no:2068724722
courier_name : aramex ( delhivery, aramex, fedex_priority, fedex_economy)

Json response
{ "response":"Success", "result":[ { "pickup_no":"123456", "message":"Updated Sucessfully" } ] }