Get started

    API Endpoint

        https://web.hideliver.app/api 
        

        Authorization: Bearer YOUR API KEY
        Content-Type: multipart/form-data

The HiDeliver API provides programmatic access to POST/GET delivery requests and cancel them. In order to use it, you need an API Key, which you can generate under your Profile Settings options:

1. Create an account: https://web.hideliver.app/register
2. Login: https://web.hideliver.app/login
3. Generate and copy your API Key: Click Here
4. Load your balance using your favorite payment method: Recharge Now
5. Start your integration and happy delivery scheduling!

Important: Your account must have a positive balance in order to succesfully schedule delivery requests. The cost is automatically discounted from your balance and credited back if canceled.

You can download our Postman collection for you to test sending delivery requests. Please make sure to add your API Key under the collection Authorization settings:

Download Postman Collection (Production)
Flowers in Chania

Post a Delivery Request


	# Here is a curl example
	curl \
	-X POST https://web.hideliver.app/api/deliverrequest \
	-F 'bearer token=your_api_key'

To Post a Delivery Request you need to make a POST call to the following url :
https://web.hideliver.app/api/deliverrequest


	Result example Error Case:
	{
		"status": false,
		"message": "Invalid bearerToken"
	}
	Result example Success Case:
	{
		"status": true,
		"message": "Tu solicitud de entrega se ha agendado satisfactoriamente",
		"data": {
			"full_name": "Melvin Leon",
			"whatsapp_number": "+1 786 245 5526",
			"city": "Medley",
			"company_name": "Hi deliver",
			"sender_city": "Medley",
			"sender_pickupaddress": "8518 NW 66th Street",
			"sender_pickupaddress2": "Suite 205",
			"sender_instructions": "Call before Arriving",
			"d_address": "8518 NW 61th street",
			"delivery_address_2": "Suite 14",
			"des_email": "[email protected]",
			"d_comments": "test comments",
			"delivery_term": "3",
			"price": "10",
			"pay_on_de": "true",
			"cash_amount_collect": "100",
			"package_size": "2",
			"pro_category": "Clothes and Accessories",
			"user_id": 1,
			"external_code": "1234557",
			"label_link": "https://pub-cdn.apitemplate.io/2022/11/78c14773-17c5-47fd-b807-12cd292dbecf.pdf",
			"need_lable": "1",
			"insurance": "1",
			"d_form": "1",
			"dprice": "35.10",
			"sender_phone_number": "+1 786245 5526",
			"sender_email": "[email protected]",
			"origin": "api",
			"status": "1",
			"updated_at": "2022-11-05T07:44:58.000000Z",
			"created_at": "2022-11-05T07:44:58.000000Z",
			"id": 1388
		}
	}

QUERY PARAMETERS

Field	Type	Description
delivery_id	Charters	Minimum 6 Unique Characters required
d_form	number	1 = 2-Hours Delivery 2 = Same/Next Day Delivery 3 = Pallet Delivery
delivery_term	String	3 = Same-Day 4 = Next-Day
pro_category	string	Product category or description
insurance	number	1 = Yes 2 = No
need_lable	number	1 = Yes 2 = No
package_size	number	1 = Small 2 = Medium 3 = Large
price	number	Product Declared Value
pay_on_de	bool	true, false
cash_amount_collect	number	100
notification	number	Choose the notifications channel 1 = Email 2 = SMS 3 = Whatsapp
notification_lang	String	Choose the notifications language en = English es = Spanish
company_name	String	Sender Name
sender_city	String	Sender City
sender_pickupaddress	String	Sender Pick-Up Address
sender_pickupaddress2	String	Dpto, floor, unit, suite, building
sender_instructions	String	Sender Pick-Up Comments
sender_email	String	Sender Email Address
sender_phone_number	String	Sender Phone Number
full_name	String	Destination Name
city	String	Destination City
d_address	String	Destination Delivery Address
delivery_address_2	String	Dpto, floor, unit, suite, building
d_comments	String	Destination Comments
des_email	String	Destination Email Address
whatsapp_number	String	Destination Phone Number

Get Delivery Requests


# Here is a curl example
curl \
-X GET https://web.hideliver.app/api/deliverrequest \
-F 'bearer token=your_api_key'

To Get a list of all your delivery requests you need to make a GET call to the following url :
https://web.hideliver.app/api/deliverrequest


Result example Error Case:
{
	"status": false,
	"message": "Invalid bearerToken"
}
Result example Success Case:

{
    "status": true,
    "message": "Record Found",
    "data": [
        
        {
            "id": 570,
            "full_name": "Melvin Leon,
            "whatsapp_number": "+50222929682,
            "city": "Ciudad de Guatemala",
            "d_address": "6 avenida zona 9",
            "d_comments": "Llamar Antes de Llegar, Codigo de acceso 3",
            "delivery_term": "3",
            "price": "10",
            "pay_on_de": "true",
            "cash_amount_collect": "100",
            "package_size": "2",
            "pro_category": "Clothes and Accessories",
            "external_code": "DELGT550862359",
            "label_link": "https://pub-cdn.apitemplate.io/2022/08/dd005942-9ded-4bc4-80a0-59d66eee5b02.pdf",
            "status": "1",
            "created_at": "2022-08-09T08:48:34.000000Z",
            "updated_at": "2022-08-09T08:48:34.000000Z",
            "user_id": "7",
            "need_lable": "1",
            "insurance": "1",
            "d_form": "1"
        }
    ]
}

Get Delivery Request Details


# Here is a curl example
curl \
-X GET https://web.hideliver.app/api/deliverrequest/DELGT579741294 \
-F 'bearer token=your_api_key'

To Get the Delivery Requestdetails you need to make a Get call to the following url :
https://web.hideliver.app/api/deliverrequest/DELGT579741294


Result example Error Case:
{
	"status": false,
	"message": "Invalid bearerToken"
}
Result example Success Case:

{
    "status": true,
    "message": "Record Found",
    "data": [
        {
            "id": 1,
            "full_name": "syed",
            "whatsapp_number": "+50235404323",
            "city": "Ciudad de Guatemala",
            "d_address": null,
            "d_comments": "Delivery Address comments or instructions",
            "delivery_term": "4",
            "price": "150",
            "pay_on_de": "false",
            "cash_amount_collect": "150",
            "package_size": "1",
            "pro_category": "Jewelry",
            "external_code": "DELGT579741294",
            "label_link": null,
            "status": "21",
            "created_at": "2022-06-29T00:00:37.000000Z",
            "updated_at": "2022-07-24T06:57:14.000000Z",
            "user_id": "7",
            "need_lable": null,
            "insurance": null,
            "d_form": "2"
        }
    ]
}

Field	Type	Description
external_code	String	value.

Cancel Request


# Here is a curl example
curl \
-X GET https://web.hideliver.app/api/deliverrequest/cancel/DELGT579741294 \
-F 'bearer token=your_api_key'

To Cancel Delivery Request you need to make a Get call to the following url :
https://web.hideliver.app/api/deliverrequest/cancel/DELGT579741294


Result example Error Case:
{
	"status": false,
	"message": "Invalid bearerToken"
}
Result example Success Case:

{
    "message": "Tu solicitud de entrega ha sido cancelada",
    "status": true
}

Field	Type	Description
external_code	String	value.

Transactions Details


# Here is a curl example
curl \
-X GET https://web.hideliver.app/api/transactions \
-F 'bearer token=your_api_key'

To Cancel Delivery Request you need to make a Get call to the following url :
https://web.hideliver.app/api/transactions


Result example Error Case:
{
	"status": false,
	"message": "Invalid bearerToken"
}
Result example Success Case:

{
    "status": true,
    "message": "Record Found",
    "data": [
        {
            "id": 1,
            "transactions_number": "420953",
            "type": "Recharge",
            "delivery_id": null,
            "amount": "51",
            "admin_id": null,
            "user_id": "7",
            "status": "1",
            "proof": null,
            "reject_reason": null,
            "accept_reason": null,
            "created_at": "2022-07-03T22:54:30.000000Z",
            "updated_at": "2022-07-03T22:54:30.000000Z",
            "deliver_data": null
        }
    ]
}

Field	Type	Description
external_code	String	value.