The Found Hero API allows you to programmatically manage your locations. A location can be a hotel, airport, airline, amusement park, shopping mall, zoo, event, etc.
Found Hero currently supports the following location types:
Value | Description |
| Airline |
| Airport |
| Amusement Park |
| Event/Festival |
| City & Government |
| Golf Course |
| Hospital |
| Hotel/Resort (Default) |
| Public Transportation |
| Restaurant |
| Shopping Mall |
| Zoo/Animal Park/Aquarium |
| None of the above |
hotel
US
10:00
14:00
{"status": true,"message": "Location is created","data": {"pickupTime": {"from": "10:00","to": "14:00"},"storageDuration": 45,"active": true,"_id": "5f29a6a2af7c9568fe1437f7","user": "5f1c11c77431601b2fff7459","name": "Four Seasons Hotel Chicago","permalink": "four-seasons-hotel-chicago-TIqfTF","identifier": "8LiwV5xppI3s","website": "https://www.fourseasons.com/chicago/","type": "hotel","contact": {"name": "David Backem","email": "[email protected]","phone": "+1 (455) 4567-8974"},"storagePlace": "House Keeping","address1": "120 E. Delaware Place","city": "Chicago","state": "IL","zipCode": "60611","country": "US","createdAt": "2020-08-04T18:19:14.471Z","updatedAt": "2020-08-04T18:19:14.471Z"}}
{"status": false,"message": "Location name is required"}
{"status": true,"data": {"contact": {"name": "David Backem","email": "[email protected]","phone": "+1 (455) 4567-8974"},"pickupTime": {"from": "10:00","to": "14:00"},"storageDuration": 45,"active": true,"_id": "5f29a6a2af7c9568fe1437f7","user": "5f1c11c77431601b2fff7459","name": "Four Seasons Hotel Chicago","permalink": "four-seasons-hotel-chicago-TIqfTF","identifier": "8LiwV5xppI3s","website": "https://www.fourseasons.com/chicago/","type": "hotel","storagePlace": "House Keeping","address1": "120 E. Delaware Place","city": "Chicago","state": "IL","zipCode": "60611","country": "US","createdAt": "2020-08-04T18:19:14.471Z","updatedAt": "2020-08-04T18:19:14.471Z"}}
{"status": false,"message": "Location not found"}
US
10:00
14:00
{"status": true,"message": "Location is updated","data": {"contact": {"name": "David Backem","email": "[email protected]","email2": null,"phone": "+1 (455) 4567-8974"},"pickupTime": {"from": "08:00","to": "14:00"},"storageDuration": 30,"active": true,"_id": "5f29a6a2af7c9568fe1437f7","user": "5f1c11c77431601b2fff7459","name": "Four Seasons Hotel Chicago","permalink": "four-seasons-hotel-chicago-TIqfTF","identifier": "8LiwV5xppI3s","website": "https://www.fourseasons.com/chicago/","type": "hotel","storagePlace": "House Keeping","address1": "120 E. Delaware Place","city": "Chicago","state": "IL","zipCode": "60611","country": "US","createdAt": "2020-08-04T18:19:14.471Z","updatedAt": "2020-08-04T18:42:13.114Z","__v": 0,"address2": null,"description": "#1 hotel in Chicago","latitude": null,"longitude": null}}
{"status": false,"message": "Location not found"}
term
to search locations by their names, descriptions, contact emails, and contact names.
This method also supports pagination. You can use limit
and page
query parameters to control pagination.10
and 100
. The default value is 10
1
{"status": true,"data": {"locations": [{"contact": {"name": "David Backem","email": "[email protected]","email2": null,"phone": "+1 (455) 4567-8974"},"pickupTime": {"from": "08:00","to": "14:00"},"storageDuration": 30,"active": true,"_id": "5f29a6a2af7c9568fe1437f7","user": "5f1c11c77431601b2fff7459","name": "Four Seasons Hotel Chicago","permalink": "four-seasons-hotel-chicago-TIqfTF","identifier": "8LiwV5xppI3s","website": "https://www.fourseasons.com/chicago/","type": "hotel","storagePlace": "House Keeping","address1": "120 E. Delaware Place","city": "Chicago","state": "IL","zipCode": "60611","country": "US","createdAt": "2020-08-04T18:19:14.471Z","updatedAt": "2020-08-04T18:42:13.114Z","__v": 0,"address2": null,"description": "#1 hotel in Chicago","latitude": null,"longitude": null}],"page": 1,"limit": 10,"count": 1,"totalPages": 1,"hasMore": false}}
{"status": true,"message": "Location deleted successfully"}
{"status": false,"message": "Location not found"}
Be careful while deleting a location. It will also immediately delete all active and shipped lost items associated with this location.
Content-Type
header to multipart/form-data
.{"status": true,"message": "Logo is uploaded successfully","data": "https://cdn.joinfoundhero.com/l/0d5c6820-4402-d1dc-4392-a6751fd8dcd1.png"}
{"status": false,"message": "File size must not exceed 2MB"}