Wix Headless

name: "How to Code Rentals" description: The frontend read/booking contract for a Wix Rentals site — a delta on how-to-code-bookings.md. Covers filtering the catalog to rentals, the two-call hourly availability flow (start slots then end options), the consecutive-day walk for daily rentals, duration-based price preview, and the createBooking → ecom Cart V2 → checkout-or-place sequence with the rentals app id. Specifies the how (modules + exact calls + rentals-specific failure modes); which rentals to render and how the page looks come from the request.

RECIPE: How to Code a Wix Rentals Frontend (Services V2 duration ranges + ecom Cart V2 checkout)

⚠️ Read how-to-code-bookings.md first — this recipe is a DELTA on it, not a replacement. Wix Rentals runs on the Wix Bookings APIs, so the client setup, the schema-driven booking form, the createBooking → ecom Cart V2 → checkout-or-place sequence, and the postFlowUrl HTTPS trap are all identical and are documented there. This file covers only what differs for a rental: finding rentals, duration-range availability, duration-based pricing, and the handful of rentals-specific errors.

⚠️ There is no @wix/rentals package, and that is not a gap. Rentals is @wix/bookings with rentals-specific field values. If a run concludes "Wix Rentals has no headless surface" because npm has no @wix/rentals, that conclusion is wrong — build on @wix/bookings.

Rentals doc set (four pages, where to go beyond this recipe): About Wix Rentals · Rentals and the Bookings APIs (concept → API map) · About Rentals Availability · Sample Flows (the booking sequences below, end to end).

⚠️ Reading rule — always append .md?apiView=SDK to every doc link below. The bare/REST view shows id; the SDK view shows _id, and the SDK is what your frontend calls.

Constants and modules (the delta)

Constants (e.g. src/services/constants.ts):

• Wix Rentals app id — ff5d6eb1-65e4-4f9a-8b14-64d34c12cc2e. Used three times: to filter the catalog to rentals, as the cart's catalogReference.appId, and to filter bookings reads (§Cancellation).

Modules — all on @wix/bookings, alongside the ones how-to-code-bookings.md already lists:

1 · Find the rentals

⚠️ CRITICAL: always filter by the rentals app id. Rentals share every API with Bookings. On a site that has both, an unfiltered queryServices returns haircuts next to meeting rooms. Every catalog read must carry appId = ff5d6eb1-65e4-4f9a-8b14-64d34c12cc2e.

catalogSearch.queryServicesByFilters is the right entry point for a rental catalog: it filters and resolves availability in one call.

const { results, pagingMetadata } = await catalogSearch.queryServicesByFilters({
  query: {
    filter: { appId: RENTALS_APP_ID },
    sort: [{ fieldName: 'name', order: 'ASC' }],
    cursorPaging: { limit: 20 },
  },
  serviceFilters: {
    localStartDate: '2026-09-01T00:00:00',   // omit the window entirely to skip the availability check
    localEndDate:   '2026-09-08T00:00:00',   // exclusive — start of the day AFTER the window
    timeZone: 'America/New_York',
  },
});

• Each entry in results carries the full service plus an available flag. With a window set and exactMatch left unset, a service comes back when it has at least one bookable slot anywhere in the window.

• End the window at 00:00:00 of the day after the range you want, not at 23:59:59. The end boundary is exclusive, so a 23:59:59 end silently drops the last minute of the final day. This matches the daily-booking convention in §3, where a rental's endDate is midnight of the day after the last rented day.

• To grey out rather than hide unavailable rentals, set serviceFilters.includeUnavailable: true — those come back with available: false.

• Paginate by passing pagingMetadata.cursors.next back unchanged as query.cursorPaging.cursor, until next is absent.

• Location and attribute filters live in serviceFilters too — locationIds, resourceTypes, and attributes. Within one attribute, values are match-any; across different attributes, match-all.

• With no date range, no availability check runs and everything returns available: true.

Doc: https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/catalog-search/query-services-by-filters.md?apiView=SDK

Read the range off the service to drive the UI — it tells you which of the two flows below applies:

const range = service.schedule?.availabilityConstraints?.durationRange;
const isDaily = range?.unitType === 'DAY';
const min = isDaily ? range.dayOptions.minDurationInDays    : range.hourOptions.minDurationInMinutes;
const max = isDaily ? range.dayOptions.maxDurationInDays    : range.hourOptions.maxDurationInMinutes;

2 · Hourly availability — two calls, start then end

A fixed-duration service has one slot list. A rental has two steps: the customer picks a start, then picks how long.

Step 1 — start times.

const { timeSlots } = await availabilityTimeSlots.listAvailabilityTimeSlots({
  serviceId,
  timeZone,
  fromLocalDate: '2026-09-01T00:00:00',
  toLocalDate:   '2026-09-02T00:00:00',   // exclusive — start of the next day, not 23:59
  includeResourceTypeIds: [resourceTypeId],   // the service's primaryResourceType
  bookable: true,
});

⚠️ Pass includeResourceTypeIds with the service's primaryResourceType, or the slots come back with no resource to book. Each slot then carries its bookable resource in availableResources — carry that forward, createBooking needs it.

Step 2 — end times for the chosen start.

const { endOptions } = await availabilityTimeSlots.listAvailabilityTimeSlotEndOptions(
  serviceId,                                   // ⚠️ POSITIONAL first argument, not part of the options object
  { localStartDate: selected.localStartDate, timeZone, location: selected.location },
);

• ⚠️ The response field is endOptions, NOT timeSlots. listAvailabilityTimeSlots returns timeSlots; this call returns endOptions. Destructuring timeSlots here yields undefined and no error — the end-time picker just renders empty, which is indistinguishable from "no availability". If your length picker is mysteriously blank, check this first.

• location is REQUIRED — pass the selected slot's own location straight through. Omitting it fails the call.

• The service's maximum duration caps the response, so you don't need maxLocalEndDate — the cap defaults to localStartDate plus that maximum. What you actually get back also depends on availability: the options stop earlier if the resource isn't free that long, so the last end option is whichever comes first — the maximum duration, or the end of the free period.

• Every entry shares the requested localStartDate and differs only in localEndDate — that is the end-time picker.

• availableResources is always empty on end options, and totalCapacity is always 1. Take the resource from step 1, not from here.

• ⚠️ END_OPTIONS_NOT_SUPPORTED means you called this for a daily or a fixed-duration service. End options are hourly-only — branch on unitType before calling.

Docs: https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots.md?apiView=SDK · https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slot-end-options.md?apiView=SDK

3 · Daily availability — one call, then walk the days yourself

There is no end-options call for daily rentals. You list days and compute the valid end dates client-side.

⚠️ timeZone must be the site's business timezone — see the rentals availability docs for why. Don't use the visitor's browser timezone.

const { timeSlots } = await availabilityTimeSlots.listAvailabilityTimeSlots({
  serviceId, timeZone,
  fromLocalDate, toLocalDate,
  timeSlotsPerDay: 1,
  includeResourceTypeIds: [resourceTypeId],
  bookable: true,
});

After the customer picks a start date, iterate forward through the returned list and stop at the first gap, or when you hit the service's maxDurationInDays. Those are the selectable end dates. A naive "start + max days" range will offer dates across a gap and then fail at booking time.

How a daily rental is stored depends on the resource's working hours — and it changes which call you make:

For the 24/7 case, set the boundaries to midnight-to-midnight: startDate = midnight on the first day, endDate = midnight on the day after the last day. A Monday–Wednesday inclusive rental ends at midnight on Thursday. ⚠️ Wix derives allDay itself — do not set it.

For the working-hours case, build one booking per day with that day's own working-period start and end (e.g. 09:00 → 18:00), and send them together. The group is created all or nothing: any unavailable or non-consecutive day fails the whole call.

Docs: https://dev.wix.com/docs/api-reference/business-solutions/rentals/about-wix-rentals-availability.md · https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking.md?apiView=SDK

4 · Price preview (duration-based)

A rental's price depends on its length, so show the total before booking.

const { priceInfo } = await pricing.previewPrice([{
  serviceId,
  resourceId,                       // required for appointment-based services
  numberOfParticipants: 1,          // always 1 for a rental — see below
  localStartDate: '2026-09-01T09:00:00',
  localEndDate:   '2026-09-01T14:00:00',
  timeZone,                         // required whenever the local dates are sent
}]);
// priceInfo.calculatedPrice

⚠️ numberOfParticipants is required and is always 1 for a rental. Omitting it, or sending 0, fails with NUMBER_OF_PARTICIPANTS_NOT_FOUND. A rental isn't a class: one booking takes one resource, so participant count never drives the price — the duration does. The room's stated capacity ("seats 8") is a resource attribute for display, not a participant count. Same reasoning as defaultCapacity: 1 on the service (setup-rentals.md STEP 4).

⚠️ Omitting localStartDate / localEndDate / timeZone does not error — it silently falls back to participant-based pricing and returns a flat rate that ignores the duration. The customer then sees one price and is charged another. Always send all three.

Hourly is prorated per minute (minutes × base ÷ 60); daily is base × days. Doc: https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/preview-price.md?apiView=SDK

5 · Book and check out

⚠️ LIVE BOOKING PRECONDITION — the site needs a premium plan and a configured payment method. On a free site the visitor flow fails at the last step: createBooking returns PREMIUM_VALIDATION_FAILED, and placeOrder returns SITE_NOT_ACCEPTING_PAYMENTS. That's site provisioning, not a frontend bug — if a booking can't complete, the setup is incomplete, not the code.

Two things make this misleading. The same createBooking succeeds as an admin (WIX_USER), so it reads like a permissions or payload bug when it's neither — always test the visitor path. And switching the service to offline / pay-in-person does not avoid it: placeOrder still requires the site to be accepting payments. Record the precondition and surface it to the owner; don't try to code around it.

Identical to how-to-code-bookings.md § "createBooking → cart → checkout", with four substitutions:

1. endDate is the customer's chosen end, not a duration added to the start — that is the whole point of a rental.

2. resource comes from the start slot's availableResources (§2 step 1 / §3). There is no ANY_RESOURCE staff fallback here; rentals are resource-driven.

3. Map the slot's location to the booking's location — read the id as slot.location.id ?? slot.location._id, and write it under _id.

4. The cart's catalogReference.appId is the RENTALS app id, not the Bookings one:

const cart = await createCart({
  catalogItems: [{ quantity: 1, catalogReference: { catalogItemId: bookingId, appId: RENTALS_APP_ID } }],
  cart: { source: { channelType: 'WEB' } },
});

Everything downstream — calculateCart, the checkout-vs-placeOrder decision, redirects.createRedirectSession and the HTTPS postFlowUrl rule — is unchanged. Follow how-to-code-bookings.md.

⚠️ One exception: do NOT call getAnonymousActionToken / bookingsGetBookingAnonymously for a rentals booking. how-to-code-bookings.md's confirmation-page step calls these client-side as the visitor. For rentals, getAnonymousActionToken returns 403 (the method requires the Manage Bookings scope, which the visitor doesn't have) — skip that whole step. Drive the confirmation page from what you already hold from createBooking / placeOrder / the redirect return instead; don't add a call to mint or read an anonymous token.

6 · SEO on item pages, and images

⚠️ There is no WIX_APPS.rentals.* and no seoTags.ItemType.RENTAL — a rental detail page is a Bookings service item page, so it uses the bookings accessors:

• wixMetadata from WIX_APPS.bookings.servicePageMetadata — referenced directly in the export (module scope). Route param slug → identifiers.slug.

• itemType: seoTags.ItemType.BOOKINGS_SERVICE.

Everything else about the three-step item-page SEO wiring (wixMetadata export → loadSEOTagsServiceConfig(...) → <SEO.Tags>, and running the config load in the same Promise.all with .catch(() => null)) is identical to how-to-code-bookings.md § "SEO on item pages".

Images are the same trap too: service.media.mainMedia.image is a string holding a wix:image://v1/… URI, not an absolute URL. Resolve with media.getImageUrl(...) from @wix/sdk before putting it in <img src>, and guard items with no image.

Mount the slot picker, length picker and book action in a client-only island (Astro) — availability is timezone- and session-specific. SSR only the catalog and detail reads, for SEO.

Rentals-specific failure modes

Out of scope

Cancellation. A logged-in member can cancel their own rental:

• A single rental (hourly, or daily on a 24/7 resource) cancels with cancelBooking and its current revision.

• A multi-day group (daily on a working-hours resource) cancels with cancelMultiServiceBooking and the group's multiServiceBookingInfo.id, read back off any booking in the group.

⚠️ Read the booking back with queryExtendedBookings, filtered on the rentals appId. Without an appId (or createdByAppId) filter of your own, the query applies a default one that covers Bookings but not rentals, and returns 0 results — a rentals booking that exists looks like it doesn't. Naming appId in the filter suppresses that default:

  filter: { appId: RENTALS_APP_ID },

Refunds are the eCommerce Orders API, not Bookings. Also out of scope, as in bookings: waitlists, deposit/payment breakdowns, and multi-item rental carts.

Conclusion

• Rentals is @wix/bookings — there is no @wix/rentals, and its absence is not a missing capability.

• Every catalog read filters on the rentals appId, or a mixed site shows the wrong services.

• Hourly = two availability calls (start → timeSlots, then end options → endOptions, hourly-only, location required, serviceId positional). Daily = one call with timeSlotsPerDay: 1, then walk consecutive days client-side.

• Daily storage follows the resource: 24/7 → one booking (midnight to midnight-after, never set allDay); working hours → a sequential multi-service group whose id you must persist yourself.

• Price preview needs both local dates and the time zone, or it silently returns a duration-blind price.

• Booking, cart, checkout and confirmation are the bookings flow, with the rentals app id on the cart's catalogReference — except the anonymous-token confirmation step, which rentals must skip entirely (§5).

• The slot's location id must be read defensively as .location.id ?? .location._id — the SDK type says _id, but the field stays .id on the wire.

• SEO and images are the bookings ones too — WIX_APPS.bookings.servicePageMetadata and seoTags.ItemType.BOOKINGS_SERVICE; there is no rentals-specific accessor to find.