Get started

    API Endpoint

        https://merchantcouriers.com/apis/
                

The Westeros API provides programmatic access to read merchantcouriers.com data. Get data to show in form , provide an oauth connecion, and book a delivery for your customer, etc.

To use this API, you need an API key. Please contact us at info@merchantcouriers.com or go to signup page for registration to get your own API key. Developer test API key is here: pktest_ff0f85a9b351e2d2c8150bc7a15d8251

get Pickup time options


# Here is a postman example
https://merchantcouriers.com/apis/get_pickup_time_options
                

To get pickup time options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_pickup_time_options option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": [
        "6:00 am - to - 7:00 am",
        "7:00 am - to - 8:00 am",
        "8:00 am - to - 9:00 am",
        "9:00 am - to - 10:00 am",
        "10:00 am  to - 11:00 am",
        "11:00 am - to - 12:00 pm",
        "12:00 pm - to - 1:00 pm",
        "1:00 pm - to - 2:00 pm",
        "2:00 pm - to - 3:00 pm",
        "3:00 pm - to - 4:00 pm",
        "4:00 pm - to - 5:00 pm",
        "5:00 pm - to - 6:00 pm",
        "6:00 pm - to - 7:00 pm"
    ]
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get dropoff time options


# Here is a postman example
https://merchantcouriers.com/apis/get_deliver_time_options
                

To get deliver time options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_deliver_time_options option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": [
        "6:00 am - to - 7:00 am",
        "7:00 am - to - 8:00 am",
        "8:00 am - to - 9:00 am",
        "9:00 am - to - 10:00 am",
        "10:00 am  to - 11:00 am",
        "11:00 am - to - 12:00 pm",
        "12:00 pm - to - 1:00 pm",
        "1:00 pm - to - 2:00 pm",
        "2:00 pm - to - 3:00 pm",
        "3:00 pm - to - 4:00 pm",
        "4:00 pm - to - 5:00 pm",
        "5:00 pm - to - 6:00 pm",
        "6:00 pm - to - 7:00 pm"
    ]
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get dropoff areas option


# Here is a postman example
https://merchantcouriers.com/apis/get_dropoff_areas
                

To get dropoff areas options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_dropoff_areas

option value will be same as in booking api

Result example :

{
    "code": 200,
    "data": [
        "Harare",
        "Bulawayo",
        "Chinhoyi",
        "Mutare",
        "Kariba",
        "Kwekwe",
        "Kadoma",
        "Chegutu",
        "Gweru",
        "Plumtree",
        "Gwanda",
        "Zvishavane",
        "Masvingo",
        "Beitbridge",
        "Chivhu",
        "Chiredzi",
        "Bindura",
        "Victoria Falls",
        "Other"
    ]
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get package weight option


# Here is a postman example
https://merchantcouriers.com/apis/get_package_weight
                

To get package weight options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_package_weight option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": [
        "0-1 KG",
        "1.1-2 KG",
        "2.1-3 KG",
        "3.1-4 KG",
        "4.1-5 KG",
        "5.1-6 KG",
        "6.1-7 KG",
        "7.1-8 KG",
        "8.1-9 KG",
        "9.1-10 KG",
        "10.1-11 KG",
        "11.1-12 KG",
        "12.1-13 KG",
        "13.1-14 KG",
        "14.1-15 KG",
        "15.1-16 KG",
        "16.1-17 KG",
        "17.1-18 KG",
        "18.1-19 KG",
        "19.1-20 KG",
        "more"
    ]
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get package value option


# Here is a postman example
https://merchantcouriers.com/apis/get_package_value
                

To get package value options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_package_value option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": [
        "$1,00 - $50,00",
        "$50,00 - $100,00",
        "$100,00 - $500,00",
        "$500,00 - $1000,00",
        "$1000,00 - Above"
    ]
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get package quantity option


# Here is a postman example
https://merchantcouriers.com/apis/get_package_quantity
                

To get package quantity options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_package_quantity option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": {
        "1": "1 Package",
        "2": "2 Packages",
        "3": "3 Packages",
        "4": "4 Packages",
        "5": "5 Packages",
        "6": "6 Packages",
        "7": "7 Packages",
        "8": "8 Packages",
        "9": "9 Packages",
        "10": "10 Packages",
        "11": "11 Packages",
        "12": "12 Packages",
        "13": "13 Packages",
        "14": "14 Packages",
        "15": "15 Packages",
        "16": "16 Packages",
        "17": "17 Packages",
        "18": "18 Packages",
        "19": "19 Packages",
        "20": "20 Packages",
        "21": "21 Packages",
        "22": "22 Packages",
        "23": "23 Packages",
        "24": "24 Packages",
        "25": "25 Packages"
    }
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get package transport option


# Here is a postman example
https://merchantcouriers.com/apis/get_transport_options
                

To get tranport options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_transport_options option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": {
        "Car": "Car",
        "Motorbike": "Motorbike",
        "Van": "Van"
    }
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get package insurance option


# Here is a postman example
https://merchantcouriers.com/apis/get_insurance_options
                

To get insurance options you need to make a POST call to the following url :
https://merchantcouriers.com/apis/get_insurance_options option value will be same as in booking api



Result example :

{
    "code": 200,
    "data": {
        "yes": "Yes",
        "no": "No"
    }
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.

get package insurance option


# Here is a postman example
https://merchantcouriers.com/apis/save_booking
                

To save booking you need to make a POST call to the following url :
https://merchantcouriers.com/apis/save_booking All the options should be same as in the upper APIs.



Result example :

{
    "code": 200,
    "data": "your Booking id is : 275 and order number is : 82320"
}
                

API PARAMETERS

Field Type Description
api_key String Your API key.
pickup_date String date in 2021-2-24 format.
pickup_time String time that you get in pickup time options.
customer_name String customer name.
Customer_email String customer email.
Customer_phone String customer phone.
receiver_name String Delivery receiver person name.
receiver_phone String receiver phone.
drop_address String delivery dropoff address that get in API.
drop_time String drop time .
drop_date String drop date.
drop_area String area name.
price_in String in USD.
insurance String insurance option(yes/no).
weight_of_package String that get in API.
value_of_package String range that get in API.
package_quantity String exact that you get in API.
transport String one option that get in API.
note String ANy note for delivery.
more_weight String if weight is more that given options you have to mention in it.
total_price String total price of package (900 or 500 or whatever is).