Retrieve the full details of one rental item, including its options, category, images and (optionally) its prices. Pass the Rental ID number into the GET URL.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/rentals/{rental_id} | Settings Rental Inventory: Read Only or Full Access | WP/API |
Request
GET /api6/rentals/12345?apiKey=YOUR_API_KEY&_prices=true
| Parameter | Where | Required | Description |
|---|---|---|---|
| rental_id | URL path | Yes | Numeric ID of the rental item. Get IDs from API - Rentals - Retrieve List |
| apiKey | Query string | Yes | Your API key |
| _prices | Query string | No | If true, returns an array of price details by hour. The request may take a little longer |
Example using curl:
curl "https://rental.software/api6/rentals/30083?apiKey=YOUR_API_KEY"
Response
{
"id": "30083",
"createtime": "2022-04-11T13:35:18-05:00",
"parentid": "0",
"isoption": "0",
"ridename": "Themed Bounce House",
"rideorder": "0",
"rideactive": "1",
"quantity": "2",
"description": "This is a modular bouncer which can be themed perfectly to fit your party. Just pick the bouncer, then choose theme!",
"imageloc": "https://rental.software/users/images/example-bounce-house.jpg",
"weight": "0",
"electric": "1",
"dimensions": "",
"footprint": "",
"ties": "0",
"tieweight": "0",
"staff": "1",
"volunteer": "1",
"setupstaff": "0",
"setuptime": "15",
"tdowntime": "10",
"pl": "1 - Inflatable Section\n1 - 1hp Blower\n2 - 50' extension cords (g)\n8 - 50lb sand bags (g)",
"category": "34",
"serialnumber": "",
"contract": "",
"operateinst": "",
"inspectionlist": "",
"qtytype": "Limited",
"increment": "1",
"inputtype": "Dropdown",
"notes": "",
"separateunits": "0",
"structure": "",
"appendname": "0",
"contractorpay": "0.00",
"manufacturer": "",
"modelnumber": "",
"reqdepamt": "0.0000",
"reqdeptype": "pct",
"showcontract": "1",
"showemail": "1",
"showpackinglist": "1",
"showquoteform": "1",
"showquoteconfirm": "1",
"recoverytime": "0",
"options": [
"30085",
"30087",
"30089"
],
"option_required": {
"30085": "0",
"30087": "0",
"30089": "0"
},
"option_linkqty": {
"30085": "0",
"30087": "0",
"30089": "0"
},
"option_imageloc": {
"30085": null,
"30087": null,
"30089": null
},
"category_name": "Moonwalks & Bounce Houses",
"locations": [],
"location_names": [],
"lcategories": [],
"qpages": [],
"qcategories": [],
"upsells": [],
"average_rating": "3",
"total_votes": "1",
"href": "https://rental.software/api6/rentals/30083",
"createtime_ts": "1649702118",
"createtime_utc": "2022-04-11T18:35:18Z",
"request_time": 1760000000
}The example is shortened. A rental contains more fields than shown here, and your code should ignore fields it does not use.
How to Read the Response
| Field | Description |
|---|---|
| ridename, description | Item name and description |
| rideactive | 1 when the item is active |
| quantity, qtytype | How many you own, and whether the quantity is limited |
| isoption | 1 when the item is an option or accessory instead of a main rental |
| options | Rental IDs of the options and accessories attached to this item. The option_ fields give details for each one, keyed by its ID |
| category, category_name | ID and name of the item's category |
| imageloc | URL of the item's image |
| pl | The item's packing list |
| setuptime, tdowntime, recoverytime | Setup, tear down and recovery times |
| average_rating, total_votes | Customer rating of the item |
| href | URL of this item in the API |
| createtime | When the item was created, in your account's time zone. Also given as a Unix timestamp (_ts) and in UTC (_utc) |
Prices
With _prices=true the response includes a prices object. Each key is a rental length in hours and each value is the price for that length, taken from the item's default price list. The keys run from 1 to 23 hours, then in whole days (24, 48, 72 and so on) up to 720 hours, which is 30 days.
"prices": {
"1": 125,
"2": 125,
"3": 150,
"4": 175,
"24": 250,
"48": 375
}These prices come from the item's default price list. To get the price for a specific date and time, see API - Availability & Pricing API Endpoint.
Errors
| Status | Message | What to do |
|---|---|---|
| 403 | Permission access restricted | Set Settings Rental Inventory to Read Only or Full Access on the API key |
| 403 | Location access restricted | The item belongs to a location the key cannot access |
| 404 | Item not found | No rental with that ID exists in your account |
See API - Errors and Rate Limits for errors that apply to every call.