Availability blocks

Get all availability blocks
This feature is being actively developed, features and behavior of this operation may change at short notice.
Returns all availability blocks filtered by services, unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/getAll
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "4d0201db-36f5-428b-8d11-4f0a65e960cc"
    ],
    "AvailabilityBlockIds": [
        "aaaa654a4a94-4f96-9efc-86da-bd26d8db"
    ],
    "ServiceIds": [
        "bd26d8db-86da-4f96-9efc-e5a4654a4a94"
    ],
    "CreatedUtc" : {
        "StartUtc": "2020-11-04T00:00:00Z",
        "EndUtc": "2020-11-05T00:00:00Z"
    },
    "UpdatedUtc" : {
        "StartUtc": "2020-11-04T00:00:00Z",
        "EndUtc": "2020-11-05T00:00:00Z"
    },
    "CollidingUtc" : {
        "StartUtc": "2020-11-05T00:00:00Z",
        "EndUtc": "2020-11-05T00:00:00Z"
    },
    "ReleasedUtc" : {
        "StartUtc": "2020-11-04T00:00:00Z",
        "EndUtc": "2020-11-05T00:00:00Z"
    },
    "States": [
        "Confirmed"
    ],
    "ExternalIdentifiers": [
        "Block-0001"
    ],
    "ActivityStates": [
        "Active"
    ],
    "Extent": {
        "AvailabilityBlocks": true,
        "Adjustments": true,
        "ServiceOrders": false,
        "Rates": false
    },
    "Limitation": { "Count": 10 }
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
AvailabilityBlockIds
string
optional, max 1000 items
Unique identifiers of the requested Availability blocks.
ServiceIds
string
optional, max 1000 items
Unique identifiers of the Services to which Availability blocks are assigned.
CreatedUtc
​Time interval​
optional, max length 3 months
Interval in which the Availability blocks were created.
UpdatedUtc
​Time interval​
optional, max length 3 months
Interval in which the Availability blocks were updated.
CollidingUtc
​Time interval​
optional, max length 3 months
Interval in which the Availability blocks are active.
ReleasedUtc
​Time interval​
optional, max length 3 months
Interval in which the Availability blocks are released.
States
array of string Availability block state​
optional
States the availability blocks should be in.
ExternalIdentifiers
string
optional, max 1000 items
Identifiers of Availability blocks from external systems.
ActivityStates
array of string Activity state​
optional
Whether to return only active, only deleted or both records.
Extent
​Availability block extent​
required
Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned.
Availability block state
Confirmed - The block deducts availability and can have reservations assigned.
Optional - The block deducts availability and cannot have reservations assigned.
Inquired - The block does not deduct availability and cannot have reservations assigned (waitlist).
Released - The block deducts availability, but only for reservations assigned to the block before release. Remaining availability is returned back to general availability (waitlist).
Canceled - The block does not deduct availability and cannot have reservations assigned (waitlist).
Availability block extent
Property
Type
Contract
Description
AvailabilityBlocks
bool
optional
Whether the response should contain the general availability blocks.
Adjustments
bool
optional
Whether the response should contain individual availability adjustments related to availability blocks.
ServiceOrders
bool
optional
Whether the response should contain reservations related to availability blocks.
Rates
bool
optional
Whether the response should contain rates related to availability blocks.
Response
{
    "AvailabilityBlocks": [
        {
            "Id": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
            "VoucherId": null,
            "BookerId": null,
            "CompanyId": null,
            "Budget": {
                "Currency": "USD",
                "Value": 48.0
            },
            "State": "Confirmed",
            "ReservationPurpose": "Leisure",
            "CreatedUtc": "2021-10-11T13:32:32Z",
            "UpdatedUtc": "2021-10-11T13:32:32Z",
            "FirstTimeUnitStartUtc": "2021-10-14T00:00:00Z",
            "LastTimeUnitStartUtc": "2021-10-17T00:00:00Z",
            "ReleasedUtc": "2021-10-13T00:00:00Z",
            "ExternalIdentifier": "Block-0001",
            "Name": "Wedding group",
            "Notes": "Have a nice stay"
        }
    ],
    "ServiceOrders": [
        {
            "Id": "5281b551-bd90-4def-b211-acbd00d3ac8c",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "GroupId": "edad92db-0b60-4b91-a090-acbd00d3ac75",
            "Number": "61",
            "ChannelNumber": "68845CDD-1340-49B5-9071-ACBD00B1D091",
            "ChannelManagerNumber": null,
            "ChannelManagerGroupNumber": null,
            "ChannelManager": null,
            "State": "Confirmed",
            "Origin": "Connector",
            "CreatedUtc": "2020-11-05T12:50:40Z",
            "UpdatedUtc": "2020-11-06T07:59:19Z",
            "CancelledUtc": null,
            "StartUtc": "2020-11-05T00:00:00Z",
            "EndUtc": "2020-11-06T00:00:00Z",
            "ReleasedUtc": null,
            "RequestedCategoryId": "1268c440-21c5-415d-bf58-ac87008b2bda",
            "AssignedResourceId": "f97a6b96-b17f-421f-9b97-ac87008b3324",
            "AssignedResourceLocked": false,
            "BusinessSegmentId": null,
            "CompanyId": null,
            "TravelAgencyId": null,
            "AvailabilityBlockId": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
            "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
            "VoucherId": null,
            "AdultCount": 2,
            "ChildCount": 0,
            "CustomerId": "c2730cbc-53ca-440d-8b30-ac87008b30af",
            "CompanionIds": []
        }
    ],
    "Adjustments": [
        {
            "Id": "e19297af-373e-4701-b4ea-afae0129bded",
            "AvailabilityBlockId": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
            "ResourceCategoryId": "1268c440-21c5-415d-bf58-ac87008b2bda",
            "FirstTimeUnitStartUtc": "2021-10-14T00:00:00Z",
            "LastTimeUnitStartUtc": "2021-10-17T00:00:00Z",
            "UnitCount": 6,
            "ActivityState": "Active"
        }
    ],
     "Cursor": "aaaa654a4a94-4f96-9efc-86da-bd26d8db"
}
Property
Type
Contract
Description
AvailabilityBlocks
array of Availability block​
optional
Availability blocks.
ServiceOrders
array of Reservation​
optional
Service orders (for example reservations) linked to availability blocks.
Adjustments
array of Availability adjustment​
optional
Availability adjustments of availability blocks.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Availability block
Property
Type
Contract
Description
Id
string
required
Unique identifier of the availability block.
ServiceId
string
required
Unique identifier of the Service the block is assigned to.
RateId
string
required
Unique identifier of the Rate the block is assigned to.
VoucherId
string
optional
Unique identifier of the Voucher used to access specified private Rate.
BookerId
string
optional
Unique identifier of the Customer on whose behalf the block was made.
CompanyId
string
optional
Unique identifier of the Company linked to the block.
Budget
​Currency value​
optional
The tentative budget for the total price of reservations in the block.
State
string Availability block state​
required
State of the availability block.
ReservationPurpose
string Reservation purpose​
optional
The purpose of the block.
CreatedUtc
string
required
Creation date and time of the block in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the block in UTC timezone in ISO 8601 format.
FirstTimeUnitStartUtc
string
required
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
LastTimeUnitStartUtc
string
required
End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format.
ReleasedUtc
string
required
The moment when the block and its availability is released in UTC timezone in ISO 8601 format.
ExternalIdentifier
string
optional, max 255 characters
Identifier of the block from external system.
Name
string
optional
The name of the block in Mews.
Notes
string
optional
Additional notes of the block.
Add availability blocks
This feature is being actively developed, features and behavior of this operation might change on short notice.
Adds availability blocks which are used to group related Availability updates. This makes limiting public availability easier and more organized. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/add
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "AvailabilityBlocks": [
        {
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
            "VoucherCode": null,
            "Name": "Mr. Smith's block",
            "FirstTimeUnitStartUtc": "2020-11-05T00:00:00Z",
            "LastTimeUnitStartUtc": "2020-11-06T00:00:00Z",
            "ReleasedUtc": "2020-11-04T00:00:00Z",
            "ExternalIdentifier": "Block-0001",
            "Budget": {  
               "Value": 500,
               "Currency": "EUR"
            },
            "ReservationPurpose": null,
            "Notes": null,
            "State": "Confirmed",
            "BookerId": null
        }
    ]
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
AvailabilityBlocks
array of Availability block parameters​
required, max 1000 items
Availability blocks to be added.
Availability block parameters
Property
Type
Contract
Description
ServiceId
string
required
Unique identifier of the Service to assign block to.
RateId
string
required
Unique identifier of the Rate to assign block to.
VoucherCode
string
optional
Voucher code providing access to specified private Rate.
Name
string
optional
The name of the block.
FirstTimeUnitStartUtc
string
required
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
LastTimeUnitStartUtc
string
required
End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format.
ReleasedUtc
string
required
The moment when the block and its availability is released.
ExternalIdentifier
string
optional, max 255 characters
Identifier of the block from external system.
Budget
​Currency value​
optional
The tentative budget for the total price of reservations.
ReservationPurpose
string Reservation purpose​
optional
The purpose of the block.
Notes
string
optional
Additional notes of the block.
State
string Availability block state​
required
State of the availability block.
BookerId
string
optional
Unique identifier of the Booker as a creator of an availability block.
Response
{
    "AvailabilityBlocks": [
        {
            "Id": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
            "FirstTimeUnitStartUtc": "2020-11-05T00:00:00Z",
            "LastTimeUnitStartUtc": "2020-11-06T00:00:00Z",
            "ReleasedUtc": "2020-11-04T00:00:00Z",
            "ExternalIdentifier": "Block-0001"
        }
    ]
}
Property
Type
Contract
Description
AvailabilityBlocks
array of Availability block​
required
Availability blocks.
Reservation purpose
Leisure
Business
Student
Update availability blocks
This feature is being actively developed, features and behavior of this operation might change on short notice.
Updates information about the specified Availability block.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/update
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "AvailabilityBlocks": [
        {
            "AvailabilityBlockId": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
            "Name": {"Value": "Mr. John Snow block"},
            "FirstTimeUnitStartUtc":{"Value": "2021-07-05T00:00:00Z"},
            "LastTimeUnitStartUtc":{"Value": "2021-07-15T00:00:00Z"},
            "ReleasedUtc":{"Value": "2021-07-04T00:00:00Z"},
            "ExternalIdentifier": {"Value": "123456798"}
        }
    ]
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
AvailabilityBlocks
array of Availability block update parameters​
required, max 1000 items
Availability blocks to be updated.
Availability block update parameters
Property
Type
Contract
Description
AvailabilityBlockId
string
required
Unique identifier of the Availability block.
Name
​String update value​
optional
The name of the block (or null if the name should not be updated).
FirstTimeUnitStartUtc
​String update value​
required
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format (or null if the start time should not be updated).
LastTimeUnitStartUtc
​String update value​
required
End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format (or null if the end time should not be updated).
ReleasedUtc
​String update value​
required
The moment when the block and its availability is released (or null if the released time should not be updated).
ExternalIdentifier
​String update value​
optional, max 255 characters
Identifier of the block from external system (or null if the identifier should not be updated).
Response
{
    "AvailabilityBlocks": [
        {
            "Id": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
            "FirstTimeUnitStartUtc": "2020-11-05T00:00:00Z",
            "LastTimeUnitStartUtc": "2020-11-06T00:00:00Z",
            "ReleasedUtc": "2020-11-04T00:00:00Z",
            "ExternalIdentifier": "Block-0001"
        }
    ]
}
Property
Type
Contract
Description
AvailabilityBlocks
array of Availability block​
required
Availability blocks.
Delete availability blocks
Delete availability blocks. Note that an availability block containing active reservations (reservations which are not Canceled) cannot be deleted.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/delete
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "AvailabilityBlockIds": [
        "e5a4654a4a94-86da-4f96-9efc-bd26d8db",
        "aaaa654a4a94-4f96-9efc-86da-bd26d8db"
    ]
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
AvailabilityBlockIds
array of string
required, max 1000 items
Unique identifier of the Availability block to delete.
Response
{}

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`EnterpriseIds`	array of string	optional, max 1000 items	Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
`AvailabilityBlockIds`	string	optional, max 1000 items	Unique identifiers of the requested Availability blocks.
`ServiceIds`	string	optional, max 1000 items	Unique identifiers of the Services to which Availability blocks are assigned.
`CreatedUtc`	Time interval	optional, max length 3 months	Interval in which the Availability blocks were created.
`UpdatedUtc`	Time interval	optional, max length 3 months	Interval in which the Availability blocks were updated.
`CollidingUtc`	Time interval	optional, max length 3 months	Interval in which the Availability blocks are active.
`ReleasedUtc`	Time interval	optional, max length 3 months	Interval in which the Availability blocks are released.
`States`	array of string Availability block state	optional	States the availability blocks should be in.
`ExternalIdentifiers`	string	optional, max 1000 items	Identifiers of Availability blocks from external systems.
`ActivityStates`	array of string Activity state	optional	Whether to return only active, only deleted or both records.
`Extent`	Availability block extent	required	Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned.

Property	Type	Contract	Description
`AvailabilityBlocks`	bool	optional	Whether the response should contain the general availability blocks.
`Adjustments`	bool	optional	Whether the response should contain individual availability adjustments related to availability blocks.
`ServiceOrders`	bool	optional	Whether the response should contain reservations related to availability blocks.
`Rates`	bool	optional	Whether the response should contain rates related to availability blocks.

Property	Type	Contract	Description
`AvailabilityBlocks`	array of Availability block	optional	Availability blocks.
`ServiceOrders`	array of Reservation	optional	Service orders (for example reservations) linked to availability blocks.
`Adjustments`	array of Availability adjustment	optional	Availability adjustments of availability blocks.
`Cursor`	string	optional	Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Property	Type	Contract	Description
`Id`	string	required	Unique identifier of the availability block.
`ServiceId`	string	required	Unique identifier of the Service the block is assigned to.
`RateId`	string	required	Unique identifier of the Rate the block is assigned to.
`VoucherId`	string	optional	Unique identifier of the Voucher used to access specified private Rate.
`BookerId`	string	optional	Unique identifier of the Customer on whose behalf the block was made.
`CompanyId`	string	optional	Unique identifier of the Company linked to the block.
`Budget`	Currency value	optional	The tentative budget for the total price of reservations in the block.
`State`	string Availability block state	required	State of the availability block.
`ReservationPurpose`	string Reservation purpose	optional	The purpose of the block.
`CreatedUtc`	string	required	Creation date and time of the block in UTC timezone in ISO 8601 format.
`UpdatedUtc`	string	required	Last update date and time of the block in UTC timezone in ISO 8601 format.
`FirstTimeUnitStartUtc`	string	required	Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
`LastTimeUnitStartUtc`	string	required	End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format.
`ReleasedUtc`	string	required	The moment when the block and its availability is released in UTC timezone in ISO 8601 format.
`ExternalIdentifier`	string	optional, max 255 characters	Identifier of the block from external system.
`Name`	string	optional	The name of the block in Mews.
`Notes`	string	optional	Additional notes of the block.

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`EnterpriseId`	string	optional	Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
`AvailabilityBlocks`	array of Availability block parameters	required, max 1000 items	Availability blocks to be added.

Property	Type	Contract	Description
`ServiceId`	string	required	Unique identifier of the Service to assign block to.
`RateId`	string	required	Unique identifier of the Rate to assign block to.
`VoucherCode`	string	optional	Voucher code providing access to specified private Rate.
`Name`	string	optional	The name of the block.
`FirstTimeUnitStartUtc`	string	required	Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
`LastTimeUnitStartUtc`	string	required	End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format.
`ReleasedUtc`	string	required	The moment when the block and its availability is released.
`ExternalIdentifier`	string	optional, max 255 characters	Identifier of the block from external system.
`Budget`	Currency value	optional	The tentative budget for the total price of reservations.
`ReservationPurpose`	string Reservation purpose	optional	The purpose of the block.
`Notes`	string	optional	Additional notes of the block.
`State`	string Availability block state	required	State of the availability block.
`BookerId`	string	optional	Unique identifier of the Booker as a creator of an availability block.

Property	Type	Contract	Description
`AvailabilityBlocks`	array of Availability block	required	Availability blocks.

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`EnterpriseId`	string	optional	Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
`AvailabilityBlocks`	array of Availability block update parameters	required, max 1000 items	Availability blocks to be updated.

Property	Type	Contract	Description
`AvailabilityBlockId`	string	required	Unique identifier of the Availability block.
`Name`	String update value	optional	The name of the block (or `null` if the name should not be updated).
`FirstTimeUnitStartUtc`	String update value	required	Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format (or `null` if the start time should not be updated).
`LastTimeUnitStartUtc`	String update value	required	End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format (or `null` if the end time should not be updated).
`ReleasedUtc`	String update value	required	The moment when the block and its availability is released (or `null` if the released time should not be updated).
`ExternalIdentifier`	String update value	optional, max 255 characters	Identifier of the block from external system (or `null` if the identifier should not be updated).

Property	Type	Contract	Description
`AvailabilityBlocks`	array of Availability block	required	Availability blocks.

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`EnterpriseId`	string	optional	Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
`AvailabilityBlockIds`	array of string	required, max 1000 items	Unique identifier of the Availability block to delete.

Availability adjustments

Bills

Last modified 25d ago