Add availability blocks
POST /api/connector/v1/availabilityBlocks/add
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 Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
Availability blocks to be added.
object
Unique identifier of the Service to assign block to.
Unique identifier of the Rate to assign block to.
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
The moment when the block and its availability is released, in UTC timezone ISO 8601 format. Takes precedence over RollingReleaseOffset.
Exact offset from the start of availability adjustments to the moment the availability adjustment should be released, in ISO 8601 duration format. Ignored if ReleasedUtc is specified.
The name of the block.
Voucher code providing access to specified private Rate.
Unique identifier of the Booker as a creator of an availability block.
Unique identifier of Company.
Unique identifier of travel agency (Company with a TravelAgencyContract).
The tentative budget for the total price of reservations.
object
The purpose of the block.
Leisure
Business
Student
Identifier of the block from external system.
Additional notes of the block.
State of the availability block.
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).)
Canceled (The block does not deduct availability and cannot have reservations assigned (waitlist).)
Unique identifier of the Mews Events quote associated with the availability block.
Unique number of the purchase order. This number is propagated to any newly picked up Reservation within the block.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "AvailabilityBlocks": [ { "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", "Name": "Mr. Smith's block", "Budget": { "Currency": "USD", "Value": 48 }, "ExternalIdentifier": "Block-0001", "State": "Confirmed" }, { "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "FirstTimeUnitStartUtc": "2021-11-05T00:00:00Z", "LastTimeUnitStartUtc": "2021-11-06T00:00:00Z", "Name": "Rolling release block", "Budget": { "Currency": "USD", "Value": 48 }, "ExternalIdentifier": "Block-0002", "State": "Confirmed" } ], "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}Responses
Section titled “ Responses ”OK
object
Availability blocks.
object
Unique identifier of the availability block.
Unique identifier of the enterprise.
Unique identifier of the Service the block is assigned to.
Unique identifier of the Rate the block is assigned to.
Unique identifier of the Voucher used to access specified private Rate.
Unique identifier of the Customer on whose behalf the block was made.
Unique identifier of the Company linked to the block.
Unique identifier of Companywith Travel agency contract the Availability Block is related to.
The tentative budget for the total price of reservations in the block.
object
State of the availability block.
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).)
Canceled (The block does not deduct availability and cannot have reservations assigned (waitlist).)
The purpose of the block.
Leisure
Business
Student
Creation date and time of the block in UTC timezone in ISO 8601 format.
Last update date and time of the block in UTC timezone in ISO 8601 format.
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. See Time units.
End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. See Time units.
The moment when the block and its availability is released in UTC timezone in ISO 8601 format. Mutually exclusive with RollingReleaseOffset; the block will not be automatically released if neither ReleasedUtc nor RollingReleaseOffsetUtc is specified.
Exact offset from the start of availability adjustments to the moment the individual days in the adjustment should be released, in ISO 8601 duration format. Mutually exclusive with ReleasedUtc; the block will not be automatically released if neither ReleasedUtc nor RollingReleaseOffsetUtc is specified.
Identifier of the block from external system.
The name of the block in Mews.
Additional notes of the block.
Whether assigning spaces to reservations within an availability block is done as a single group or divided into individual groups.
AllInOneGroup (All created reservations in the block are added to the same reservation group.)
IndividualGroups (Reservations can be picked up in multiple groups, with up to 750 reservations per group.)
Whether the Availability Block is still active.
Unique identifier of the Mews Events quote associated with the availability block.
Unique number for a specific availability block within the Mews system.
The strategy for automatic release of the availability block.
FixedRelease (The availability block is released at a fixed time.)
RollingRelease (Each availability adjustment is released at a fixed offset from its start.)
None (The availability block is not automatically released.)
Unique number of the purchase order. This number is propagated to any newly picked up Reservation within the block.
Example
{ "AvailabilityBlocks": [ { "Id": "5ee074b1-6c86-48e8-915f-c7aa4702086f", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "VoucherId": null, "BookerId": "ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72", "CompanyId": null, "TravelAgencyId": null, "Budget": { "Currency": "USD", "Value": 48, "Net": null, "Tax": null, "TaxRate": null }, "State": "Confirmed", "ReservationPurpose": "Leisure", "CreatedUtc": "2020-11-04T13:00:00Z", "UpdatedUtc": "2020-11-04T13:00:00Z", "FirstTimeUnitStartUtc": "2020-11-04T13:00:00Z", "LastTimeUnitStartUtc": "2020-11-04T13:00:00Z", "ReleasedUtc": "2020-11-04T13:00:00Z", "RollingReleaseOffset": null, "ExternalIdentifier": "Block-0001", "Name": "Wedding group", "Notes": "Have a nice stay", "PickupDistribution": "AllInOneGroup", "IsActive": false, "QuoteId": null, "AvailabilityBlockNumber": "478", "ReleaseStrategy": "FixedRelease", "PurchaseOrderNumber": "XX-123" }, { "Id": "c32386aa-1cd2-414a-a823-489325842fbe", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "VoucherId": null, "BookerId": "ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72", "CompanyId": null, "TravelAgencyId": null, "Budget": { "Currency": "USD", "Value": 48, "Net": null, "Tax": null, "TaxRate": null }, "State": "Confirmed", "ReservationPurpose": "Leisure", "CreatedUtc": "2022-10-11T13:32:32Z", "UpdatedUtc": "2022-10-11T13:32:32Z", "FirstTimeUnitStartUtc": "2022-10-14T00:00:00Z", "LastTimeUnitStartUtc": "2022-11-17T00:00:00Z", "ReleasedUtc": null, "RollingReleaseOffset": "P-3DT4H", "ExternalIdentifier": "Block-0002", "Name": "Rolling release", "Notes": null, "PickupDistribution": "AllInOneGroup", "IsActive": false, "QuoteId": "67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c", "AvailabilityBlockNumber": "479", "ReleaseStrategy": "RollingRelease", "PurchaseOrderNumber": null } ], "ServiceOrders": null, "Adjustments": [ { "Id": "e19297af-373e-4701-b4ea-afae0129bded", "AvailabilityBlockId": "5ee074b1-6c86-48e8-915f-c7aa4702086f", "ResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "StartUtc": null, "EndUtc": null, "FirstTimeUnitStartUtc": "2021-10-14T00:00:00Z", "LastTimeUnitStartUtc": "2021-10-17T00:00:00Z", "UnitCount": 6, "ActivityState": "Active", "ReleaseOverrideUtc": "2021-10-13T00:00:00Z", "UpdatedUtc": "2021-10-21T13:32:32Z", "IsActive": false, "PaxCounts": null, "FirstTimeUnitReleaseUtc": "2021-10-13T00:00:00Z" } ], "Rates": null, "Cursor": "c32386aa-1cd2-414a-a823-489325842fbe"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.