> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt ## Resource: Wix Rentals and the Bookings APIs ## Article: Wix Rentals and the Bookings APIs ## Article Link: https://dev.wix.com/docs/api-reference/business-solutions/rentals/wix-rentals-and-the-bookings-apis.md ## Article Content: # Wix Rentals and the Bookings APIs [Wix Rentals](https://dev.wix.com/docs/api-reference/business-solutions/rentals/introduction.md) has no APIs of its own. It stores its services, bookings, and calendar events in the same entities as [Wix Bookings](https://dev.wix.com/docs/api-reference/business-solutions/bookings/introduction.md), using field values and restrictions specific to rentals. This article maps each rentals concept to the API that manages it. ## Services A rental offering is a [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction.md) with the following field values: - `type` is always `APPOINTMENT`. - `appId` is always `ff5d6eb1-65e4-4f9a-8b14-64d34c12cc2e`. - `schedule.availabilityConstraints.durationRange` replaces `sessionDurations`. These fields are mutually exclusive, so a service uses 1 or the other. - `schedule.availabilityConstraints.durationRange.unitType` is either `HOUR` or `DAY`. Each unit type has its own configuration: - Hourly services set `hourOptions.minDurationInMinutes` and `hourOptions.maxDurationInMinutes`. Both values range from 30 to 1440 minutes. - Daily services set `dayOptions.minDurationInDays` and `dayOptions.maxDurationInDays`. Both values range from 1 to 8 days. - `primaryResourceType` holds a [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction.md) ID instead of staff members. Wix derives availability from the schedules of the resources in that type. Learn more about [Wix Rentals availability](https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md). - `payment.rateType` is always `FIXED`. Learn more about [pricing](#pricing). A service supports a single unit type. To rent the same resource by the hour and by the day, create a separate service for each. Services created by Wix Rentals don't appear in the Wix Bookings services list. They appear in the Wix Rentals section of the site dashboard. Learn more about [duration range services](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-duration-range-services.md). ## Pricing A rental costs more the longer a customer keeps it. Wix Rentals uses the [Pricing API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/introduction.md) to charge a service's base price as a rate per unit of time, rather than a flat price per session. The rate is per hour for an hourly service and per day for a daily service. The final price is the base price multiplied by the number of units the customer books. For an hourly service, Wix calculates the price at per-minute granularity, so a customer who books a partial hour pays a proportional amount. The price is the chosen duration in minutes multiplied by the base price divided by 60. On a service priced at $10 per hour, a 90-minute rental costs $15. Because the price depends on the length of the rental, `BookingLineItem` also carries `localStartDate`, `localEndDate`, and `timeZone`. To show the customer an estimated price before creating the booking, call [Preview Price](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/preview-price.md) with these fields. Learn more about [how customers select a duration](https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md). ## Bookings Wix Rentals stores reservations as [bookings](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/introduction.md). ### Duration fields Rental bookings carry 2 additional read-only fields on `bookedEntity.slot`, which Wix populates only for services configured with a duration range: - `durationUnitType`: The booking unit, either `HOUR` or `DAY`. - `durationUnitCount`: The booked duration. When `durationUnitType` is `HOUR`, this is a number of minutes, so a 2-hour rental has a `durationUnitCount` of `120`. When `durationUnitType` is `DAY`, this is a number of days. Because both fields are read-only, don't set them when creating a booking. Wix derives them from the slot's start and end times. ### Booking creation The unit type and the resource's schedule determine how many bookings a reservation creates: - Hourly rentals: A single booking covers the selected time range. Call [Create Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/create-booking.md) with the customer's chosen start and end times. - Daily rentals on a resource with working hours: 1 booking per day, each spanning the resource's full working period. Call [Create Multi Service Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/introduction.md) with `multiServiceBookingType` set to `SEQUENTIAL_BOOKINGS`. A group holds between 2 and 8 bookings. - Daily rentals on a 24/7 resource: A single booking covers the full date range. Call Create Booking with the start and end dates set to midnight. Learn more about [resource schedules](https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md#resource-schedules) and which of these paths applies. For a multi-day rental on a 24/7 resource, Wix sets `bookedEntity.slot.allDay` to `true` on the resulting booking. Wix sets this field, so don't set it yourself. When it's `true`, `startDate` is midnight on the first day and `endDate` is midnight on the day after the last day, interpreted in the slot's time zone. A rental from Monday to Wednesday inclusive therefore ends at midnight on Thursday. ### Booking retrieval Rental bookings appear in the business calendar alongside other booking types. To retrieve them, filter by the Wix Rentals app ID, as described in [Identify Wix Rentals entities in the API](https://dev.wix.com/docs/api-reference/business-solutions/rentals/introduction.md). ## Calendar events Wix Rentals creates and updates [calendar events](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction.md) automatically as bookings change. A daily rental on a resource with working hours gets 1 event per day. An hourly rental gets a single timed event, and a daily rental on a 24/7 resource gets a single all-day event covering the full range.
__Important:__ Don't interact directly with Calendar APIs to manage rental bookings. Use the [Create Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/create-booking.md), [Create Multi Service Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/introduction.md), and [Cancel Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking.md) methods instead.
## Attributes Resources can carry custom typed properties through the [Bookings Attributes API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/attributes/introduction.md). An attribute definition, such as string, number, or boolean, is created once per site, then per-resource values are set using the resource ID as the `entityId`. For example, a vacation rentals business might define `capacity` as a number, `bedType` as a string, and `hasWifi`as a boolean, then store per-room values that are displayed on the public site. ## Forms Wix Rentals uses the same [Wix Forms](https://dev.wix.com/docs/api-reference/crm/forms/introduction.md) integration as Wix Bookings. Provisioning creates the booking form under `wix.rentals.form`. Learn more about the [Wix Bookings forms integration](https://dev.wix.com/docs/api-reference/business-solutions/bookings/wix-forms-integration.md). ## Catalog search The [Catalog Search API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/catalog-search/introduction.md) lets you query a site's service catalog and get back only the services that customers can book, each including availability data. In a single call, you can filter by business location, resource type, resource attributes, and an availability window. To retrieve only rental services, specify the Wix Rentals app ID in the filter parameter, as described in [Identify Wix Rentals entities in the API](https://dev.wix.com/docs/api-reference/business-solutions/rentals/introduction.md). Catalog search complements the Time Slots V2 API used for [Wix Rentals availability](https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md). Use catalog search to discover which rental services are available across the catalog, and Time Slots V2 to let the customer select a specific start and end time for a chosen service. Learn more about [how catalog search matches an availability window for rentals](https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md#catalog-wide-availability). ## See also - [About Wix Rentals](https://dev.wix.com/docs/api-reference/business-solutions/rentals/introduction.md) - [About Wix Rentals Availability](https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md) - [Wix Rentals: Sample Flows](https://dev.wix.com/docs/api-reference/business-solutions/rentals/sample-flows.md) - [About Duration Range Services](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-duration-range-services.md) - [About Service Types](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-service-types.md) - [Pricing API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/introduction.md) - [About Service Payments](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-service-payments.md) - [Catalog Search API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/catalog-search/introduction.md)