Booking API - Developer Guide

The List of Property endpoint allows users to retrieve a list of properties available in the system. This information includes details such as property ID, name, address, geographical coordinates, contact information, and images. The API response also provides pagination information for large result sets.

Explore endpoints

The List of Property endpoint allows users to retrieve property details by ID through a GET request. It returns a single result, i.e., a property object, only if the provided ID matches an existing property; otherwise, it returns null. The information includes details such as property ID, name, address, geographical coordinates, contact information, and images.

Explore endpoints

The Size & Price Listing endpoint returns the unit size groups and sizes available for a specified property and storage type, priced for the requested payment period and user type. Results are organized by storage type and category and include active discounts, plan options, and availability—making it easy to compare distinct prices for the same size and decide whether to rent or book.

Explore endpoints

The Pre-Booking Quote Retrieval API endpoint offers comprehensive information on quotes for requested storage boxes. The quote comes in two variations: for the prorated period from the move-in date to the last invoice cycle and for a complete invoice cycle. The primary details include property details and storage box specifics, providing a quick overview for decision-making when booking.

Explore endpoints

The Save Booking Activity endpoint allows the creation of a booking activity to facilitate the move-in process. This activity serves as an intermediary step to store tenant information, and subsequent additions such as insurance, services, merchandise, and discounts can be associated with this primary key. The booking activity acts as a central identifier in managing leads through the pipeline to finalize deals.

Explore endpoints

The Booking Activity and Quote Retrieval API endpoint provides detailed information on tenant activity and quotes for requested storage boxes, including selected add-ons such as insurance, service, merchandise items, and applicable discounts. The quote is available in two variations: for the prorated period from the move-in date to the last invoice cycle and for a complete invoice cycle. The primary details encompass tenant information, property details, and storage box specifics, providing a quick overview for booking inquiries.

Explore endpoints

The Save Reservation and Booking Activity endpoint allows the creation of a booking activity to facilitate the move-in process and reserve the storage box. This activity serves as an intermediary step to store tenant information along with the reservation. Subsequent additions such as insurance, services, merchandise, and discounts can be associated with this primary key. The booking activity acts as a central identifier in managing leads through the pipeline to finalize deals, while the reservation ensures the storage box is reserved for the tenant.

Explore endpoints

The Get Reservation Details by ID endpoint provides comprehensive information about a specific reservation and its associated booking activity. This includes primary details about tenant activity, quotes for requested storage boxes, and details on selected add-ons such as insurance, service, merchandise items, and applicable discounts. The quote is available in two variations: for the prorated period from the move-in date to the last invoice cycle and for a complete invoice cycle. The primary details encompass tenant information, property details, and storage box specifics, offering a quick overview for booking inquiries.

Explore endpoints

The Insurance List endpoint provides a list of insurance options tailored to specific booking activities, considering the size of the storage box, whether in terms of area or volume. The list is fetched based on the associated booking ID.

Explore endpoints

The Insurance List endpoint provides a list of insurance options tailored to specific sizes respective to the property and Storge type ID, considering the size of the storage box, whether in terms of area or volume. The list is fetched based on the associated property and Storge type ID. If you pass zero to areaOrVolume, it will return all the insurance options on the associated property and Storge type ID irrespective of the size filter.

Explore endpoints

This endpoint links the proposed insurance coverage to an existing booking activity. If any insurance is already linked, it will be switched to the newly proposed insurance coverage.

Explore endpoints

This endpoint generates a pre-filled contract document based on the provided booking activity ID. The generated document includes comprehensive information such as client details, property information, storage box details, payment terms, and other relevant information. The PDF document is created for viewing purposes and can be accessed through the provided URLs.

Explore endpoints

This endpoint enables the storage of the client's signature in temporary memory for subsequent move-in processing. It proves particularly useful after the successful completion of the payment process. It's essential to note that the client signature will be permanently deleted upon the successful move-in or within one day, as part of compliance with data protection regulations. This practice ensures that no personal information is retained on the server for an extended period.

Explore endpoints

Generate a payment intent for a booking and receive all UI keys needed to load the selected payment gateway. This endpoint supports multiple gateways and methods (e.g., Stripe CARD/SEPA, Lyra, Viva, Brain Tree). If a gateway/method is not specified in the request, the property’s default configuration is used. The selected option is echoed in data.paymentGateway and data.paymentMethod. Gateway-specific values are returned in data.terminalPaymentSecretId (Stripe: payment intent; Lyra: KR form token; Brain Tree: client token; Viva: redirect URL to complete payment), plus data.publicKey and data.languageLCIDCode where applicable.

Explore endpoints

This endpoint validates a successful payment intent ID from the Stripe payment gateway and initiates the creation of a rental contract, invoice, receipt voucher, and charges entry for the specified booking ID. The resulting contract will include signed documents, addons, and any applicable discounts saved during the move-in flow. The API returns the rental contract ID upon successful completion of the move-in process.

Explore endpoints

This endpoint validates a successful POST request with content type 'application/x-www-form-urlencoded' received from the Lyra payment gateway after a successful payment redirection. It expects the same POST data (formData["kr-answer"]) and initiates the creation of a rental contract, invoice, receipt voucher, and charges entry for the specified booking ID. The resulting contract includes signed documents, addons, and any applicable discounts saved during the move-in flow. The API returns the rental contract ID upon successful completion of the move-in process.

Explore endpoints

This endpoint receives the nonce from the BrainTree UI after a successful card save process. The API processes the nonce and charges the card for the respective move-in proforma invoice (i.e., quote shared during the move-in process). If the payment using the nonce is successful, it initiates the creation of a rental contract, invoice, receipt voucher, and charges entry for the specified booking ID. The resulting contract includes signed documents, addons, and any applicable discounts saved during the move-in flow. The API returns the rental contract ID upon successful completion of the move-in process.

Explore endpoints