Property Details by ID

Retrieve Property by ID API Endpoint
StoRegister - Login

Retrieve Property by ID

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.

GET
/v1/search/property/{id}
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 property.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve property details by ID 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 property details by ID (e.g., "SUCCESS" or "ERROR").

  • data object | null

    Upon success, this property contains the retrieved property information. If the provided ID matches an existing property, it returns an object with details such as property ID, name, address, geographical coordinates, contact information, and images. If the ID does not match, the value is null.

  • errors array

    Holds error information if applicable. It is an array containing error details in case there are issues with the request to retrieve property details by ID.

object: data

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

Request Header

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

API Response

{
    "data": 
        {
            "id": "94df61e3-7334-4d56-9d4d-c740cb0e2409",
            "name": "Atlanta",
            "address": "54 rue André Vasseur",
            "city": "Toulouse",
            "latitude": 43.637150055994724,
            "longitude": 1.475090250940065,
            "postalCode": "31200",
            "country": {
                "id": 82,
                "name": "France"
            },
            "region": {
                "id": 216,
                "name": "Occitania"
            },
            "countryISOCode2": "FR",
            "googlePlaceId": "ChIJfbDAtjqjrhIRAXf_wK0KIs0",
            "contactNumber": "+33 10000000",
            "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
                }
            ]
        },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_PROPERTY_INFO_ID

    INVALID_PARAM_PROPERTY_INFO_ID refers to invalid property ID.

  • 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.
API Reference documentation