Lost Items
You can use the Found Hero API to create, update, list, and remove lost items.
Packaging Boxes
Found Hero currently supports the following packaging boxes. You should pass the value of the selected box while creating the lost item.
We are working on adding support for custom packaging boxes. It will allow users to input the width, height, and depth of the package box.
Create an item
POST
https://api.joinfoundhero.com/v1/locations/:lid/items
This endpoint allows you to create a new lost item. Found Hero will automatically notify the owner when the guest details are provided.
Path Parameters
Request Body
Retrieve an item
GET
https://api.joinfoundhero.com/v1/locations/:lid/items/:id
This endpoint allows you to retrieve the details of a lost item that has previously been created. Just pass the unique location and item IDs, and Found Hero will return the corresponding lost item information.
Path Parameters
Update an item
PUT
https://api.joinfoundhero.com/v1/locations/:lid/items/:id
This endpoint allows you to update the lost item information.
Path Parameters
Request Body
Retrieve all items by location
GET
https://api.joinfoundhero.com/v1/locations/:lid/items
Retrieve all lost items associated with a specific location. By default, this method returns a set of 10 most recent lost items.
You can also supply an optional query parameter called term
to search lost items by their descriptions and guest information.
This method also supports pagination. You can use limit
and page
query parameters to control pagination.
Path Parameters
Query Parameters
Delete an item
DELETE
https://api.joinfoundhero.com/v1/locations/:lid/items/:id
This endpoint allows you to permanently delete a lost item. It cannot be undone.
Path Parameters
Upload an image
POST
https://api.joinfoundhero.com/v1/locations/:lid/items/:id/upload-image
This endpoint allows you to upload an image for the lost item. For this particular request, you must set the request Content-Type
header to multipart/form-data
.
Path Parameters
Request Body
Update Item Status
PUT
https://api.joinfoundhero.com/v1/locations/:lid/items/:id/update-status
This endpoint allows you to update item status. The different item status are : case 'PENDING' : return 'Waiting for response' case 'INFO COMPLETED : 'Recipient details filled' case 'FEE PAID' : return 'Shipping fee paid' case 'SHIPPED' : return 'In route' case 'DELIVERED' : return 'Safely Delivered' case 'DISCARD' : return 'Left behind' case 'PICKUP' : return 'Pick up by guest' case 'DONATE' : return 'Donate to chartiy'
Path Parameters
Request Body
Last updated