Get Reservation Details by ID API

Get Reservation Details by ID API Endpoint
StoRegister - Login

Get Reservation Details by ID API

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.

GET
/v1/booking/reservation/{id}/detail
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

URL Query Parameters:

  • id string required

    id refers to a ID of the specific Reservation.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve tenant reservation and booking activity 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 reservation and booking activity. It is a string providing additional information about the status.
  • data object | null

    Upon success, this property contains detailed information about tenant reservation and booking activity, including 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. If the operation 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 reservation and booking activity.

object: data

  • id unique-identifier

    Unique identifier for the booking transaction.
  • transactId string

    Transaction ID associated with the booking.
  • transactDate string

    Date of the transaction.
  • moveInDate string

    Move-in date for the storage box.
  • client object

    Client details (refer to Client Details section).
  • billingSubscription object

    Billing subscription details (refer to Billing Subscription Details section).
  • proRataSubscription object

    Prorated subscription details (refer to Pro-Rata Subscription Details section).
  • property object

    Property details (refer to Property Details section).
  • storage object

    Storage details, including storage box ID and name.
  • storageSize object

    Storage size details, including size, scale metrics, default size metrics, length, width, and height.

Client Details

Details about the tenant or client, providing comprehensive information about their identity and contact details.

object: data.client
  • id unique-identifier

    Tenant ID.
  • name string

    Full name of the tenant.
  • email string

    Email address of the tenant.
  • phoneNumber string

    Phone number of the tenant.
  • address string

    Street address of the tenant.
  • city string

    City of residence for the tenant.
  • region integer

    State or Province or County ID (if applicable) for the tenant, by default 0.
  • postalCode string

    Postal code of the tenant's location.
  • country object

    Details about the client's country, including ID and Name.

Billing Subscription and Pro-Rata Subscription Details

Detailed information on the billing subscription and prorated subscription, including non-taxable amount, taxable amount, tax amount, net amount, gross amount, rent details, discounts, insurance, service, and merchandise details.

object: data.billingSubscription and data.proRataSubscription
  • startDate string

    Start date of the billing subscription (e.g., "04-02-2024").
  • endDate string

    End date of the billing subscription (e.g., "03-03-2024").
  • nonTaxableAmount object

    Details about the non-taxable amount, including price and formatted price.
  • taxableAmount object

    Details about the taxable amount, including price and formatted price.
  • taxAmount object

    Details about the tax amount, including price and formatted price.
  • netAmount object

    Details about the net amount, including price and formatted price.
  • grossAmount object

    Details about the gross amount, including price and formatted price.
  • rent object

    Details about the rent, including ID, description, taxable price, tax percentage, tax price, payable price, and period.
  • discount object

    Details about any discounts applied.
  • insurance object

    Details about insurance, including ID, description, taxable price, tax percentage, tax price, payable price, and period.
  • service object

    Details about any additional services.
  • merchandise object

    Details about any merchandise items.
  • transactData object

    Details about a consolidated group of items chosen by the tenant to prepare the quote (refer to Transaction Item Details section).

Transaction Item Details

Details about the transaction items chosen by the tenant to prepare the quote. Each transaction item is identified by its category, such as 'RENT', 'RENTAL_DISCOUNT', 'INSURANCE', 'SERVICE', etc.

object: data.transactData
  • name string

    The name of the transaction item (e.g., "4.00m2").
  • description string

    A description of the transaction item, including duration (e.g., "4.00m2 (Duration: 05-02-2024 to 04-03-2024)").
  • category string

    The category of the transaction item, identifying its type (e.g., 'RENT', 'RENTAL_DISCOUNT', 'INSURANCE', 'SERVICE', etc.).
  • nonTaxableAmount object | null

    Details about the non-taxable amount, including price and formatted price. If no non-taxable amount, it will be null.
  • taxableAmount object

    Details about the taxable amount, including price and formatted price.
  • taxPercentage object

    Details about the tax percentage, including price and formatted price.
  • taxAmount object

    Details about the tax amount, including price and formatted price.
  • netAmount object

    Details about the net amount, including price and formatted price.
  • grossAmount object

    Details about the gross amount, including price and formatted price.

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 Details

Details about the size of the storage box, including size, scale metrics, default size metrics, length, width, and height.

object: data.storageSize
  • size float

    Size of the storage in specified metrics (e.g., 2.5).
  • scaleMetrics string

    Scale metrics used for the size (e.g., "m" for meters).
  • defaultSizeMetrics string

    Default size metrics for the storage (e.g., "AREA", "VOLUME").
  • length float

    Length dimension of the storage box.
  • width float

    Width dimension of the storage box.
  • height float

    Height dimension of the storage box.

Request Header

Authorization: X-API-Key --api-key--

API Response

{
    "data": {
        "id": "3d491954-4ec3-466b-a7bc-a95b506aa8f3",
        "transactId": "CRS11",
        "transactDate": "05-02-2024",
        "reservationDate": "09-02-2024",
        "client": {
            "id": "42d7c9d3-bd30-4315-94f0-4c1a924d7b38",
            "name": "Renaud Pons",
            "email": "[email protected]",
            "phoneNumber": "0 345656768",
            "address": "",
            "city": "",
            "region": 0,
            "postalCode": "",
            "country": {
                "id": 0,
                "name": ""
            }
        },
        "property": {
            "id": "a99c4590-9475-404e-bcbd-6cba2e2b5e16",
            "name": "Chalets",
            "address": "13 rue des Chalets",
            "city": "Toulouse",
            "latitude": 43.615232811359924000,
            "longitude": 1.441923783106378700,
            "postalCode": "31000",
            "country": {
                "id": 82,
                "name": "France"
            },
            "region": {
                "id": 216,
                "name": "Occitania"
            },
            "countryISOCode2": "FR",
            "googlePlaceId": "ChIJ62YIC1-7rhIRhD_iH8qTlRo",
            "contactNumber": "+33 0522243838",
            "propertyImageList": [
                "property.jpg"
            ],
            "propertyOfficeOpeningHoursInfoList": [
                {
                    "dayOfWeek": 0,
                    "week": "dimanche",
                    "firstTimeSlot": null,
                    "secondTimeSlot": null,
                    "isClosed": true
                },
                {
                    "dayOfWeek": 1,
                    "week": "lundi",
                    "firstTimeSlot": "09:00 To 12:30",
                    "secondTimeSlot": "13:30 To 19:00",
                    "isClosed": false
                },
                {
                    "dayOfWeek": 2,
                    "week": "mardi",
                    "firstTimeSlot": "09:00 To 12:30",
                    "secondTimeSlot": "13:30 To 19:00",
                    "isClosed": false
                },
                {
                    "dayOfWeek": 3,
                    "week": "mercredi",
                    "firstTimeSlot": "09:00 To 12:30",
                    "secondTimeSlot": "13:30 To 19:00",
                    "isClosed": false
                },
                {
                    "dayOfWeek": 4,
                    "week": "jeudi",
                    "firstTimeSlot": "09:00 To 12:30",
                    "secondTimeSlot": "13:30 To 19:00",
                    "isClosed": false
                },
                {
                    "dayOfWeek": 5,
                    "week": "vendredi",
                    "firstTimeSlot": "09:00 To 12:30",
                    "secondTimeSlot": "13:30 To 19:00",
                    "isClosed": false
                },
                {
                    "dayOfWeek": 6,
                    "week": "samedi",
                    "firstTimeSlot": "09:00 To 12:30",
                    "secondTimeSlot": "13:30 To 19:00",
                    "isClosed": false
                },
                {
                    "dayOfWeek": -1,
                    "week": null,
                    "firstTimeSlot": null,
                    "secondTimeSlot": null,
                    "isClosed": true
                }
            ]
        },
        "storage": {
            "id": "47fa29c4-738a-42dc-bcb3-6dba1ee7e38e",
            "name": "Box"
        },
        "storageSize": {
            "size": 4,
            "scaleMetrics": "m",
            "defaultSizeMetrics": "AREA",
            "length": 2,
            "width": 2,
            "height": 2.7
        },
        "billingSubscription": {
            "startDate": "09-02-2024",
            "endDate": "08-03-2024",
            "taxUserType": null,
            "nonTaxableAmount": {
                "price": 0,
                "formattedPrice": "0,00 €"
            },
            "taxableAmount": {
                "price": 27.08,
                "formattedPrice": "27,08 €"
            },
            "taxAmount": {
                "price": 5.42,
                "formattedPrice": "5,42 €"
            },
            "netAmount": {
                "price": 32.50,
                "formattedPrice": "32,50 €"
            },
            "grossAmount": {
                "price": 32.50,
                "formattedPrice": "32,50 €"
            },
            "rent": {
                "id": "2cd76f68-eb93-4fcd-93f5-44a3e43be24d",
                "description": "Box - 4m2 ",
                "taxablePrice": {
                    "price": 27.08,
                    "formattedPrice": "27,08 €"
                },
                "taxPercentage": {
                    "percentage": 20.00,
                    "formattedPercentage": "20,00 %"
                },
                "taxPrice": {
                    "price": 5.42,
                    "formattedPrice": "5,00 %"
                },
                "payablePrice": {
                    "price": 32.50,
                    "formattedPrice": "32,50 €"
                },
                "period": null
            },
            "discount": null,
            "insurance": null,
            "service": null,
            "merchandise": null,
            "transactData": [
                {
                    "name": "Box - 4m2",
                    "description": "Box - 4m2 (Duration: 09-02-2024 to 08-03-2024)",
                    "categeory": "RENT",
                    "nonTaxableAmount": null,
                    "taxableAmount": {
                        "price": 27.08,
                        "formattedPrice": "27,08 €"
                    },
                    "taxPercentage": {
                        "price": 20.00,
                        "formattedPrice": "20.00"
                    },
                    "taxAmount": {
                        "price": 5.42,
                        "formattedPrice": "5,42 €"
                    },
                    "netAmount": {
                        "price": 32.50,
                        "formattedPrice": "32,50 €"
                    },
                    "grossAmount": {
                        "price": 32.50,
                        "formattedPrice": "32,50 €"
                    }
                }
            ]
        },
        "proRataSubscription": {
            "startDate": "09-02-2024",
            "endDate": "08-03-2024",
            "taxUserType": null,
            "nonTaxableAmount": {
                "price": 0,
                "formattedPrice": "0,00 €"
            },
            "taxableAmount": {
                "price": 27.08,
                "formattedPrice": "27,08 €"
            },
            "taxAmount": {
                "price": 5.42,
                "formattedPrice": "5,42 €"
            },
            "netAmount": {
                "price": 32.50,
                "formattedPrice": "32,50 €"
            },
            "grossAmount": {
                "price": 32.50,
                "formattedPrice": "32,50 €"
            },
            "rent": {
                "id": "2cd76f68-eb93-4fcd-93f5-44a3e43be24d",
                "description": "Box - 4m2 ",
                "taxablePrice": {
                    "price": 27.08,
                    "formattedPrice": "27,08 €"
                },
                "taxPercentage": {
                    "percentage": 20.00,
                    "formattedPercentage": "20,00 %"
                },
                "taxPrice": {
                    "price": 5.42,
                    "formattedPrice": "5,00 %"
                },
                "payablePrice": {
                    "price": 32.50,
                    "formattedPrice": "32,50 €"
                },
                "period": "09-02-2024 to 08-03-2024"
            },
            "discount": null,
            "insurance": null,
            "service": null,
            "merchandise": null,
            "transactData": [
                {
                    "name": "Box - 4m2",
                    "description": "Box - 4m2 (Duration: 09-02-2024 to 08-03-2024)",
                    "categeory": "RENT",
                    "nonTaxableAmount": null,
                    "taxableAmount": {
                        "price": 27.08,
                        "formattedPrice": "27,08 €"
                    },
                    "taxPercentage": {
                        "price": 20.00,
                        "formattedPrice": "20.00"
                    },
                    "taxAmount": {
                        "price": 5.42,
                        "formattedPrice": "5,42 €"
                    },
                    "netAmount": {
                        "price": 32.50,
                        "formattedPrice": "32,50 €"
                    },
                    "grossAmount": {
                        "price": 32.50,
                        "formattedPrice": "32,50 €"
                    }
                }
            ]
        }
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_RESERVATION_INFO_ID

    INVALID_PARAM_RESERVATION_INFO_ID refers to invalid reservation ID.
  • INVALID_RESERVATION_INFO_DETAILS

    INVALID_RESERVATION_INFO_DETAILS refers to unable to retreive the reservation details.
  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.
  • FAILED

    FAILED refers to an unsuccessful API call.
  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.