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").

• paymentPeriod string (enum) required

  paymentPeriod selects the billing unit for pricing. Accepted values: MONTHLY or WEEKLY. The endpoint returns the default period for the chosen unit—1 month when MONTHLY, 1 week when WEEKLY. Additional durations (e.g., 3 or 12 months) may also be present in the pricing maps.

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

  On success, contains the Size & Price Listing result: property (property metadata), storage (storage type info), and propertySizePriceData (size groups and sizes with plan options, rental/booking price breakdowns, applied discounts, tax details, final payable amounts, and availability counts such as units available to rent/book), all computed for the requested paymentPeriod and user type. If the request fails or no data is available, 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

Comprehensive information about the property, including its identifiers, display name, address, city, region, country, geographic coordinates, postal code, contact details, office and access hours, images, and other related attributes.

object: data.property

• id unique-identifier

  Unique identifier for the property.

• name string

  Name of the property.

• identifier string (slug)

  SEO-friendly identifier/slug for the property (used in URLs and routing).

• brandName null or string

  Brand label for the property (if the site operates multiple brands).

• displayName string

  Customer-facing name for the property used in UI and communications.

• emailId string (email)

  Primary email contact for the property location.

• address string

  Street address of the property.

• city string

  City where the property is located.

• region object

  Administrative region/state where the property is located (contains id and name).

• 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.

• officeHours string

  Formatted office hours text shown to customers.

• accessHours string

  Formatted access hours text for tenant entry (e.g., 7/7 access windows).

• 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.

Payment Period Options

Available billing cycles for this property (e.g., Monthly, Quarterly), including their durations.

array data.property.paymentPeriod

• id unique-identifier

  Unique identifier of the payment period option.

• name string

  Display label of the payment period (e.g., “Monthly”, “Quarterly”).

• duration integer (months)

  Number of months that define the billing cycle.

• paymentPeriod null or string

  Canonical code for the period if present (null when not applicable).

Additional Property Data

Supplementary metrics and lookup lists used for pricing and UI display.

object data.property.additionalData

• minimumSize null or number

  Smallest advertised unit size at this property (if available).

• maximumSize null or number

  Largest advertised unit size at this property (if available).

• rentStartsFrom object

  Lowest starting rent across sizes, including raw value and localized formatting.

object data.property.additionalData.rentStartsFrom

• price number

  The lowest rental price available for this property, irrespective of the unit size. For example, 1.50 means rents at this property start from €1.50.

• formattedPrice string

  Localized display string of the lowest rent, including currency and proper formatting (e.g., 1,50 €).

array data.property.additionalData.storage

• id unique-identifier

  Storage type/category identifier (e.g., Box, Wine, Vehicle).

• name string

  Internal storage type name.

• displayName string

  User-facing storage type label (shown in UI filters and cards).

• property null or object

  Optional property reference; null when not required for this listing.

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 variants for a specific property. Categorized by storage type and category to aid decisions for renting or booking based on discounts, availability, and plan-level pricing.

array: data.propertySizePriceData

• id string

  Unique identifier for the property row.

• name string

  Internal name of the property.

• displayName null|string

  Customer-facing name of the property.

• brandName null|string

  Brand label if the site runs multiple brands.

• city null|string

  City name where the property is located.

• geoLocationInfoId number

  Geolocation identifier.

• geoLocationInfoName null|string

  Geolocation name/region label.

• countryId number

  Numeric country identifier.

• country null|string

  Country name.

• countryInfoISOCode2 null|string

  ISO-3166 alpha-2 code (e.g., “FR”).

• zipCode null|string

  Postal/ZIP code.

• addressLine1 null|string

  Primary street address line.

• addressInfoLatitude number

  Latitude of the property coordinates.

• addressInfoLongitude number

  Longitude of the property coordinates.

• googlePlaceId null|string

  Google Place ID referencing the location.

• contactNumberDialingCode number

  Dialing code for the phone number.

• contactNumber null|string

  Primary contact number for the property.

• emailId null|string

  Contact email address for the property.

• officeHours null|string

  Formatted office hours text.

• accessHours null|string

  Formatted tenant access hours text.

• identifier string

  SEO-friendly slug used in links/routing (e.g., “toulouse-est”).

• onlinePortalPrivilege string (enum)

  Portal capability for this context (e.g., RENT, BOOK, INQUIRE).

• strorageInfoId string

  Unique identifier for the storage type (JSON key as provided).

• storageInfoName string

  Display name of the storage type (e.g., “Box Storage”).

• storageInfoDimensionType string (enum)

  Dimension grouping (e.g., BOX).

• sizes array

  List of storage sizes for this storage type (see “Storage Size Details”).

object: data.propertySizePriceData[].sizes[]

• storageSizeGroupMasterInfoId number

  Master group identifier for size banding.

• storageSizeGroupInfoId string (uuid)

  Unique identifier of the size group.

• storageSizeGroupInfoName string

  Label for the size group (e.g., “L - 7 à 10,5 m²”).

• width number

  Width of the unit (in scaleMetrics units).

• length number

  Length of the unit.

• height number

  Height of the unit (0 when not captured).

• surface number

  Calculated area/surface for the unit.

• scaleMetrics string

  Measurement scale (e.g., m).

• sizeMetrics string

  Size metric type (e.g., AREA).

• availableCount number

  Number of units currently available for this size.

• storageSpaceSizeInfoId string

  Identifier for the concrete size record.

• storageSizeImageAssetInfoId string

  Asset identifier for the illustrative image.

• storageSizeImageInfoPath string (url)

  URL to the size image.

• storageSizeDescription null|string

  Optional description for the size group.

• storageSpaceSizeAssumedVolume number

  Assumed volume for planning/quotes (0 when not set).

• storageCategory array

  List of categories and their pricing for this size (see “Storage Category Details”).

Storage Category Details

• id string

  Identifier for the storage category.

• name string

  Display name of the storage category.

• rent array

  Pricing containers for this category/size (see “Pricing Containers”).

Pricing Containers

Each item represents either the minimum price option or a specific plan option for the size/category.

object: minimumStoragePrice  and  allStoragePrice[]

• facilityPlanInfoId string (uuid)

  Plan identifier (e.g., building level or facility plan).

• facilityPlanInfoName string

  Plan name (e.g., “Level 2”).

• rentalPrice object (map)

  Dictionary keyed by period (months) as strings (e.g., "1", "3", "12"), each value containing a full price breakdown (see “Booking and Rental Price Details”).

• bookingPrice null|object

  Booking price breakdown for the same plan (null if not applicable).

• availableSpaceForRent number

  Units available to rent under this plan.

• availableSpaceForBook number

  Units available to book under this plan.

Booking and Rental Price Details

object: bookingPrice  and  rentalPrice["<months>"]

• discountInfoId string

  Identifier for the applied discount rule.

• discountPropertyInfoId string

  Property link for the discount, if scoped to property.

• discountDescription null|string

  Human-readable description of the discount.

• taxablePrice object

  Base price before tax (see “Price Details”).

• tax object

  Tax metadata (see “Tax Details”).

• taxAmount object

  Computed tax amount (see “Price Details”).

• netAmount object

  Total including tax before discounts (see “Price Details”).

• discountAmount object

  Absolute discount value (see “Price Details”).

• discountPercentage null|number

  Percentage discount when provided (null if not applicable).

• payableAmount object

  Final amount due after tax and discounts (see “Price Details”).

• quantity number

  Quantity multiplier used for the priced period.

Price Details

Price objects carry both numeric and formatted values for display and calculations.

object: taxablePrice, taxAmount, netAmount, discountAmount, payableAmount

• price number

  Numeric amount used for computation.

• formattedPrice string

  Localized display string (currency & separators), e.g., 30,00 €.

Tax Details

• name string

  Tax label (e.g., “VAT”).

• taxPercentage number

  Tax rate in percentage (e.g., 20).

• taxPercentageFormatted string

  Localized rate string (e.g., 20,00 %).