Sign in

v1

latestSwagger 2.02026-08-04283399898.4 KB
rentals

Create rental

post/rentals

Query parameters

idinteger
namestring
vehicle_titlestring
typestring
descriptionstring
sleepsinteger
seatbeltsinteger
minimum_renter_ageinteger
sleeps_adultsinteger
sleeps_kidsinteger
summarystring
publishedboolean
publish_field_errorsstring[]
unpublish_reasonstring
last_unpublish_datestring
group_on_mapboolean
primary_image_urlstring
primary_image_idinteger
interior_primary_image_urlstring
interior_primary_image_idinteger
has_checkout_questionsboolean
positioninteger
externalboolean
description_includedstring
description_recommendationsstring
description_otherstring
waived_insurance_textstring
custom_insurance_textstring
insurance_coveragestring
require_roadsideboolean
current_location_idinteger
mileage_usage_item_idinteger
generator_usage_item_idinteger
delivery_usage_item_idinteger
cancel_policystring

configurable rental options. must be stored as a pointer so we can know if it is unset in the database or not and fall back to the user level

cancel_policy_combo_bookingsstring
minimum_depositinteger
minimum_daysinteger
instant_bookboolean
instant_book_leewayinteger
instant_book_typestring
request_less_than_minimum_daysinteger
insurance_renter_adjustableboolean
turnaround_days_afterinteger
booking_leeway_daysinteger
require_insuranceboolean
smart_pricing_enabledboolean
smart_pricing_modestring
smart_pricing_mininteger
smart_pricing_maxinteger
ny_insurance_warningboolean
one_way_rental_requestsboolean
one_way_rental_maximum_radiusinteger
tax_rate_idsinteger[]
exempt_rental_sales_taxboolean
applies_to_typestring[]

DBStringSlice is a []string with database conversion methods

availableinteger
categorystring
category_idinteger
consigned_pay_pctnumber double

consigned owner support

dailyboolean
deferredboolean
descriptionstring
hiddenboolean
idinteger
image_urlstring
ledger_account_numberinteger
location_idinteger
location_idsinteger[]
maximum_priceinteger nullable
{"stackTrail":"components:schemas:IMap","oasType":"schema","type":"unknown","extensionFields":{"x-go-package":"github.com/outdoorsy/api/pkg/jsonb"}}
minimum_priceinteger nullable
namestring
percentnumber double
percent_typestring
positioninteger
presentment_currencystring
priceinteger
rental_items_category_idinteger nullable
rental_items_category_namestring
rental_items_category_owner_namestring
rental_items_category_reasonstring
rental_items_category_requested_namestring
rental_items_category_statusstring
requiredboolean
settlement_currencystring
taxinteger

total tax - calculated

tax_rate_idsinteger[]
travelersinteger
instant_book_bannedboolean

Rental-level instant book ban (stored in metadata, combo bookings only)

instant_book_ban_datestring
original_urlstring

Importing

internal_notesstring
createdstring

Admin, owner Fields

last_publishedstring
first_publishedstring
snooze_expiration_datestring
updatedstring
sortnumber double

Admin Fields

hiddenboolean
hidden_reasonstring
import_idstring
internal_idstring
roamly_policy_numberstring
inactiveboolean
external_site_urlstring
auto_insurance_typestring
has_completed_lyrvboolean
turo_vehicle_idstring
tollspot_idinteger
rejected_images_countinteger

holds the count of images with status rejected and ignore rejected false

can_manage_tax_ratesboolean

used by dashboard to disable tax editing

use_system_tax_ratesboolean

used by rental listing page to display system tax notice

eligible_for_system_tax_ratesboolean

For wheelbase so we can show when a rental will use system tax rates

eligible_for_custom_tax_ratesboolean

We allow custom taxes for Quebec which has also system tax rates

parent_idinteger

grouping functionality

images_verifiedboolean

moderation

images_verified_byinteger
photo_scoreinteger
review_statusstring
review_notesstring
Createdstring
IDinteger
Namestring
Slugstring
Updatedstring
positioninteger
usage_by_rental_countinteger
free_form_typedboolean

free form typed flag

rental_categorystring
check_ininteger
check_outinteger
bypass_new_york_regulationsboolean

Admins can mark a vehicle to bypass New York regulations check

od_stays_opt_inboolean
od_stays_opt_in_eligibleboolean
od_stays_opt_in_missing_requirementsstring[]
sd_waiver_enabledboolean

Response

auto_insurance_typestring
booking_leeway_daysinteger nullable
bypass_new_york_regulationsboolean

Admins can mark a vehicle to bypass New York regulations check

can_manage_tax_ratesboolean

used by dashboard to disable tax editing

cancel_policystring nullable
cancel_policy_combo_bookingsstring nullable
check_ininteger
check_outinteger
checkout_questionsobject[]

DBMSISlice is a []string with database conversion methods

createdstring

Admin, owner Fields

current_location_idinteger
custom_insurance_textstring nullable
delivery_usage_item_idinteger
descriptionstring
description_includedstring
description_otherstring
description_recommendationsstring
eligible_for_custom_tax_ratesboolean

We allow custom taxes for Quebec which has also system tax rates

eligible_for_system_tax_ratesboolean

For wheelbase so we can show when a rental will use system tax rates

exempt_rental_sales_taxboolean
externalboolean nullable
external_site_urlstring
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
first_publishedstring
free_form_typedboolean

free form typed flag

generator_usage_item_idinteger
group_on_mapboolean
has_checkout_questionsboolean
has_completed_lyrvboolean
hiddenboolean
hidden_reasonstring nullable
idinteger
images_verifiedboolean nullable
images_verified_byinteger nullable
import_idstring
inactiveboolean
instant_bookboolean nullable
instant_book_ban_datestring
instant_book_bannedboolean

Rental-level instant book ban (stored in metadata, combo bookings only)

instant_book_leewayinteger nullable
instant_book_typestring
insurance_coveragestring
insurance_renter_adjustableboolean nullable
interior_primary_image_idinteger
interior_primary_image_urlstring
internal_idstring
internal_notesstring
last_publishedstring
last_unpublish_datestring
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
{"stackTrail":"components:schemas:IMap","oasType":"schema","type":"unknown","extensionFields":{"x-go-package":"github.com/outdoorsy/api/pkg/jsonb"}}
mileage_usage_item_idinteger
minimum_daysinteger nullable
minimum_depositinteger nullable
minimum_renter_ageinteger
namestring
ny_insurance_warningboolean
od_stays_opt_inboolean
od_stays_opt_in_eligibleboolean
od_stays_opt_in_missing_requirementsstring[]
one_way_rental_maximum_radiusinteger nullable
one_way_rental_requestsboolean nullable
original_urlstring

Importing

parent_idinteger

grouping functionality

photo_scoreinteger nullable
positioninteger
primary_image_idinteger
primary_image_urlstring
publish_field_errorsstring[]
publishedboolean
rejected_images_countinteger

holds the count of images with status rejected and ignore rejected false

rental_categorystring
request_less_than_minimum_daysinteger
require_insuranceboolean nullable
require_roadsideboolean nullable
review_notesstring nullable
review_statusstring nullable
roamly_policy_numberstring
sd_waiver_enabledboolean nullable
seatbeltsinteger
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
sleepsinteger
sleeps_adultsinteger
sleeps_kidsinteger
smart_pricing_enabledboolean
smart_pricing_maxinteger
smart_pricing_mininteger
smart_pricing_modestring
snooze_expiration_datestring
sortnumber double

Admin Fields

{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
summarystring
tax_rate_idsinteger[]
tollspot_idinteger
turnaround_days_afterinteger nullable
turo_vehicle_idstring
typestring
unpublish_reasonstring
updatedstring
use_system_tax_ratesboolean

used by rental listing page to display system tax notice

vehicle_titlestring
waived_insurance_textstring nullable