Size and Price Listing for Property

URL Query Parameters:

• propertyInfoId unique-identifier required

  propertyInfoId refers to the ID of the specific property.

• storageInfoId unique-identifier required

  storageInfoId refers to type ID of storage (e.g., "Unit Storage", "Container Storage").

• taxUserTypeInfoId unique-identifier required

  taxUserTypeInfoId refers to type ID of the user (e.g., "General", "Business", "Student").

• storageGroupInfoId int required

  storageGroupInfoId refers to the grouping category ID for unit sizes (e.g., "Small", "Medium", "Large")..

• paymentPeriod string required

  paymentPeriod refers to payment period KEY for the list of supported payment period (e.g., "Monthly", "Quartely").

Response Payload:

• succeeded boolean

  Indicates whether the request to retrieve tenant activity and quotes for storage boxes was successful. It is a boolean value where true denotes success, and false indicates failure.

• status string

  Describes the status of the request to retrieve tenant activity and quotes. It is a string providing additional information about the status.

• data object | null

  Upon success, this property contains detailed information on tenant activity and quotes for requested storage boxes. The information includes 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. If the request is not successful, the value is null.

• errors array

  Holds error information if applicable. It is an array containing error details in case there are issues with retrieving tenant activity and quotes.

object: data

• property object

  Details about the property (refer to Property Details section).

• storage object

  Details about the storage (refer to Storage Details section).

• propertySizePriceData object

  Details about the size and its associated price based on its storage category (refer to Storage Size and Price Details section).

Property Details

Details about the property, including property name, address, city, latitude, longitude, postal code, country, and contact number.

object: data.property

• id unique-identifier

  Unique identifier for the property.

• name string

  Name of the property.

• address string

  Street address of the property.

• city string

  City where the property is located.

• latitude float

  Latitude coordinate of the property location.

• longitude float

  Longitude coordinate of the property location.

• postalCode string

  Postal code of the property location.

• country object

  Country where the property is located.

• countryISOCode2 string

  ISO code (2 characters) for the country of the property.

• googlePlaceId string

  Google Place ID associated with the property location.

• contactNumber string

  Contact number for the property.

• propertyImageList null or array

  List of property images or null if not available.

• propertyOfficeOpeningHoursInfoList null or array

  List of information about property office opening hours or null if not available (refer to the Property Working Hours section for details).

Property Working Hours

Information about the working hours of the property, including opening and closing times for each day of the week.

array data.property.propertyOfficeOpeningHoursInfoList

• dayOfWeek integer

  Day of the week represented as an integer (0 for Sunday, 1 for Monday, ..., 6 for Saturday). The value -1 represents public holidays.

• week string

  Name of the day of the week in French.

• firstTimeSlot string

  Opening and closing time of the first time slot, if applicable.

• secondTimeSlot string

  Opening and closing time of the second time slot, if applicable.

• isClosed boolean

  Indicates whether the property is closed on the specified day.

Storage Details

Information about the storage, including storage box ID and name.

object: data.storage

• id unique-identifier

  Unique identifier for the storage box.

• name string

  Name of the storage box.

Storage Size and Price Details

Information about the sizes available, their respective pricing, and various variants for a specific property. This information, categorized by storage type and category, aids in decision-making for renting or booking storage boxes based on factors such as discounts, availability, and distinct pricing for the same size.

object: data.propertySizePriceData

• id string

  Unique identifier for the property size and price data.

• name string

  Name of the property.

• storageInfoId string

  Unique identifier for the storage information associated with the property.

• storageInfoName string

  Name of the storage box associated with the property.

• storageInfoDimensionType string

  Dimension type of the storage box.

• sizes array

  List of storage sizes and details (refer to Storage Size Details section).

object: storageSizeGroupInfo

• storageSizeGroupInfoId number

  Identifier for the storage size group.

• storageSizeGroupInfoName string

  Name of the storage size group.

• width number

  Width of the storage size.

• length number

  Length of the storage size.

• height number

  Height of the storage size.

• surface number

  Surface area of the storage size.

• scaleMetrics string

  Metrics used for scale (e.g., 'm' for meters).

• sizeMetrics string

  Metrics used for size (e.g., 'AREA').

• availableCount number

  Count of available storage sizes.

• storageSpaceSizeInfoId string

  Identifier for the storage space size information.

• storageSizeImageAssetInfoId string

  Identifier for the storage size image asset.

• storageSizeImageInfoPath string

  Path to the storage size image.

Storage Size Details

• storageSizeGroupInfoId int

  Identifier for the storage size group.

• storageCategory array

  List of storage categories and details (refer to Storage Category Details section).

Storage Category Details

• id string

  Identifier for the storage category.

• price array

  List of prices for the storage category (refer to Price Details section).

Booking and Rental Price Details

object: bookingPrice and rentalPrice

• discountInfoId string

  Identifier for the discount information.

• discountPropertyInfoId string

  Identifier for the associated property information.

• discountDescription null|string

  Description of the discount (null if not available).

• taxablePrice object

  Taxable price details (refer to Taxable Price Details section).

• tax object

  Tax details (refer to Tax Details section).

• taxAmount object

  Tax amount details (refer to Tax Amount Details section).

• netAmount object

  Net amount details (refer to Net Amount Details section).

• discountAmount object

  Discount amount details (refer to Discount Amount Details section).

• payableAmount object

  Payable amount details (refer to Payable Amount Details section).

Price Details

Information about the sizes available, their respective pricing, and various variants for a specific property. This information, categorized by storage type and category, aids in decision-making for renting or booking storage boxes based on factors such as discounts, availability, and distinct pricing for the same size.

object: taxablePrice , taxAmount , netAmount , discountAmount and payableAmount

• rentalPrice object

  Rental price details (refer to Rental Price Details section).

• bookingPrice object

  Booking price details (refer to Booking Price Details section).

Tax Details

• name string

  Name of the tax.

• taxPercentage number

  Tax percentage.

• taxPercentageFormatted string

  Formatted tax percentage.