Availability blocks

Process availability block

[async] This method is used when Mews push availability blocks. It is used to send availability blocks changes such as create, modification, cancellation.

Request

[ChannelManagerApiAddress]/processAvailabilityBlock

The example shows a valid availability block definition.

{
    "connectionToken": "[Token of a concrete connection]",
    "messageId": "66511e1d-2405-4e49-914b-b0c800d802c9",
    "responseUrl": "https://api.mews-demo.com/api/channelManager/v1/processAvailabilityBlockConfirmation",
    "availabilityBlock": {
        "code": null,
        "confirmationNumber": "2",
        "status": "Create",
        "name": "SampleBlock",
        "dates": {
            "start": "2023-12-05",
            "end": "2023-12-11",
            "releasedDate": "2023-12-04"
        },
        "spaceCategories": [
            {
                "start": "2023-12-05",
                "end": "2023-12-11",
                "spaceTypeCode": "D",
                "allocatedSpaces": [
                    {
                        "start": "2023-12-05",
                        "end": "2023-12-07",
                        "count": 2
                    },
                    {
                        "start": "2023-12-08",
                        "end": "2023-12-11",
                        "count": 5
                    }
                ],
                "occupiedSpaces": [
                    {
                        "start": "2023-12-05",
                        "end": "2023-12-07",
                        "count": 1
                    },
                    {
                        "start": "2023-12-08",
                        "end": "2023-12-12",
                        "count": 0
                    }
                ],
                "rates": [
                    {
                        "start": "2023-12-05",
                        "end": "2023-12-12",
                        "currencyCode": "EUR",
                        "prices": [
                            {
                                "grossAmount": 100.00,
                                "netAmount": 93.46,
                                "currencyCode": "EUR",
                                "guestCount": 1
                            },
                            {
                                "grossAmount": 100.00,
                                "netAmount": 93.46,
                                "currencyCode": "EUR",
                                "guestCount": 2
                            },
                            {
                                "grossAmount": 100.00,
                                "netAmount": 93.46,
                                "currencyCode": "EUR",
                                "guestCount": 3
                            },
                            {
                                "grossAmount": 100.00,
                                "netAmount": 93.46,
                                "currencyCode": "EUR",
                                "guestCount": 4
                            }
                        ]
                    }
                ]
            }
        ],
        "booker": {
            "email": "[e-mail]",
            "firstName": "Angelina",
            "lastName": "Jolie",
            "title": null,
            "telephone": null,
            "nationalityCode": null,
            "languageCode": null,
            "loyaltyCode": null,
            "address": null
        },
        "company": null
    }  
}

Property	Type	Contract	Description
connectionToken	string	required	Token of a concrete connection.
messageId	string	required	Unique identification of the message. Used for asynchronous confirmations
responseUrl	string	required (always)	Url which should be used for asynchronous confirmation.
availabilityBlock	Availability block object	required	Availablity block data

Availability block

Property	Type	Contract	Description
code	string	optional	Unique reference code from external system for the block. Will be returned after confirmation containing this code.
confirmationNumber	string	required	Mews confirmation number for the block.
status	Status object	required	Represents state of block.
name	string	required	Name of block.
dates	Dates object	required	Represents dates of block.
spaceCategories	Space category allocation collection	required	Represents allocated categories of block.
booker	Customer object	required	Represents the main booker. Does not mean that the person arrives to the property.
company	Company object	optional	Represents the company associated with the block.

Dates

Property	Type	Contract	Description
start	string	required	Start date in format "yyyy-MM-dd" (e.g. "2021-12-24").
end	string	required	End date in format "yyyy-MM-dd" (e.g., "2021-12-31").
releasedDate	string	required	End date in format "yyyy-MM-dd" (e.g., "2021-12-24").

Space category allocation

Property	Type	Contract	Description
start	string	required	Start date in format "yyyy-MM-dd" (e.g. "2021-12-24").
end	string	required	End date in format "yyyy-MM-dd" (e.g., "2021-12-31").
spaceTypeCode	string	required	Space type code of the reservation.
allocatedSpaces	Space count collection	required	Represents number of spaces allocated in time.
occupiedSpaces	Space count collection	required	Represents number of occupied spaces in time.
rates	Rates collection	required	Represents prices for current space category.

Space count

Property	Type	Contract	Description
start	string	required	Start date in format "yyyy-MM-dd" (e.g. "2021-12-24").
end	string	required	End date in format "yyyy-MM-dd" (e.g., "2021-12-31").
count	int	required	Number of spaces (base of usage either occupied or allocated.)

Rate

Property	Type	Contract	Description
start	string	required	Start date in format "yyyy-MM-dd" (e.g. "2021-12-24").
end	string	required	End date in format "yyyy-MM-dd" (e.g., "2021-12-31").
currencyCode	string	required	3 letter code of currency.
prices	Price collection	required	Collection of prices for each person count for the specified rate plan - space type - date combination.

Status

• Create

• Update

• Cancel

Response

Synchronous simple response is expected to determine whether the update was accepted or not.

Async availability block confirmation is expected to determine whether the update was processed afterwards or not.