Reservations

Get all reservations
Returns all reservations from the specified interval according to the time filter (e.g. colliding with that interval or created in that interval).
Request
[PlatformAddress]/api/connector/v1/reservations/getAll
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "StartUtc": "2016-01-01T00:00:00Z",
    "EndUtc": "2016-01-07T00:00:00Z",
    "Extent": {
        "Reservations": true,
        "ReservationGroups": true,
        "Customers": true
    }
}
Property
Type
​
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.
TimeFilter
string Reservation time filter​
optional
Time filter of the interval. If not specified, reservations Colliding with the interval are returned.
StartUtc
string
required
Start of the interval in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the interval in UTC timezone in ISO 8601 format.
States
array of string Reservation state​
optional
States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states are returned.
Extent
​Reservation extent​
optional
Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned. If not specified, Reservations, Groups and Customers is used as the default extent.
Currency
string
optional
ISO-4217 code of the Currency the item costs should be converted to.
Reservation time filter
Colliding - reservations whose intervals collide with the specified interval.
Created - reservations created within the specified interval.
Updated - reservations updated within the specified interval.
Start- reservations starting (= arriving) within the specified interval.
End - reservations ending (= departing) within the specified interval.
Overlapping - reservations whose intervals contain the specified interval.
Canceled - reservations canceled within the specified interval.
Reservation extent
Property
Type
​
Description
BusinessSegments
bool
optional
Whether the response should contain business segmentation.
Customers
bool
optional
Whether the response should contain customers of the reservations.
Items
bool
optional
Whether the response should contain reservation items.
Products
bool
optional
Whether the response should contain products orderable with the reservations.
Rates
bool
optional
Whether the response should contain rates and rate groups.
Reservations
bool
optional
Whether the response should contain reservations.
ReservationGroups
bool
optional
Whether the response should contain groups of the reservations.
Services
bool
optional
Whether the response should contain services reserved by the reservations.
Spaces
bool
optional
Whether the response should contain spaces and space categories.
Notes
bool
optional
Whether the response should contain notes.
QrCodeData
bool
optional
Whether the response should contain QR code data.
AccountingStates
array of string Accounting state​
optional
States the items should be in. If not specified, items in Open or Closed states are returned.
Response
{
    "BusinessSegments": null,
    "Customers": [
        {
            "Address": null,
            "BirthDate": null,
            "BirthPlace": null,
            "CategoryId": null,
            "Classifications": [],
            "CreatedUtc": "2016-01-01T00:00:00Z",
            "Email": null,
            "FirstName": "John",
            "Gender": null,
            "Id": "35d4b117-4e60-44a3-9580-c582117eff98",
            "IdentityCard": null,
            "LanguageCode": null,
            "LastName": "Smith",
            "LoyaltyCode": null,
            "NationalityCode": "US",
            "Notes": "",
            "Number": "1",
            "Passport": null,
            "Phone": "00420123456789",
            "SecondLastName": null,
            "TaxIdentificationNumber": null,
            "Title": null,
            "UpdatedUtc": "2016-01-01T00:00:00Z",
            "Visa": null
        }
    ],
    "Items": null,
    "Products": null,
    "RateGroups": null,
    "Rates": null,
    "ReservationGroups": [
        {
            "Id": "c704dff3-7811-4af7-a3a0-7b2b0635ac59",
            "Name": "13-12-Smith-F712"
        }
    ],
    "Reservations": [
        {
            "AdultCount": 2,
            "AssignedSpaceId": "20e00c32-d561-4008-8609-82d8aa525714",
            "AssignedSpaceLocked": false,
            "BusinessSegmentId": null,
            "CancelledUtc": null,
            "ChannelNumber": "1337614414",
            "ChannelManagerNumber": "01",
            "ChannelManagerGroupNumber": "JX8PA2",
            "ChannelManager": "AvailPro",
            "ChildCount": 0,
            "CompanionIds": [
                "35d4b117-4e60-44a3-9580-c582117eff98"
            ],
            "CompanyId": null,
            "CreatedUtc": "2016-02-20T14:58:02Z",
            "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "EndUtc": "2016-02-22T11:00:00Z",
            "GroupId": "94843f6f-3be3-481b-a1c7-06458774c3df",
            "Id": "bfee2c44-1f84-4326-a862-5289598f6e2d",
            "Number": "52",
            "Origin": "Manual",
            "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
            "RequestedCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "StartUtc": "2016-02-20T13:00:00Z",
            "State": "Processed",
            "TravelAgencyId": null,
            "UpdatedUtc": "2016-02-20T14:58:02Z"
        }
    ],
    "Services": null,
    "SpaceCategories": null,
    "Spaces": null,
    "Notes": null
}
Property
Type
​
Description
BusinessSegments
array of Business segment​
optional
Business segments of the reservations.
Customers
array of Customer​
optional
Customers that are members of the reservations.
Items
array of Accounting item​
optional
Revenue items of the reservations.
Products
array of Product​
optional
Products orderable with reservations.
RateGroups
array of Rate group​
optional
Rate groups of the reservation rates.
Rates
array of Rate​
optional
Rates of the reservations.
ReservationGroups
array of Reservation group​
optional
Reservation groups that the reservations are members of.
Reservations
array of Reservation​
optional
The reservations that collide with the specified interval.
Services
array of Service​
optional
Services that have been reserved.
SpaceCategories
array of Space category​
optional
Space categories of the spaces.
Spaces
array of Space​
optional
Assigned spaces of the reservations.
Notes
array of Order note​
optional
Notes of the reservations.
QrCodeData
array of QrCode data​
optional
QR code data of the reservations.
Reservation
Property
Type
​
Description
Id
string
required
Unique identifier of the reservation.
ServiceId
string
required
Unique identifier of the Service that is reserved.
GroupId
string
required
Unique identifier of the Reservation group.
Number
string
required
Confirmation number of the reservation in Mews.
ChannelNumber
string
optional
Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number).
ChannelManagerNumber
string
optional
Unique number of the reservation within the reservation group.
ChannelManagerGroupNumber
string
optional
Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews.
ChannelManager
string
optional
Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc).
State
string Reservation state​
required
State of the reservation.
Origin
string Reservation origin​
required
Origin of the reservation.
CreatedUtc
string
required
Creation date and time of the reservation in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the reservation in UTC timezone in ISO 8601 format.
StartUtc
string
required
Start of the reservation (arrival) in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the reservation (departure) in UTC timezone in ISO 8601 format.
CancelledUtc
string
optional
Cancellation date and time in UTC timezone in ISO 8601 format.
RequestedCategoryId
string
required
Identifier of the requested Space category.
AssignedSpaceId
string
optional
Identifier of the assigned Space.
AssignedSpaceLocked
bool
required
Whether the reservation is locked in the assigned Space and cannot be moved.
BusinessSegmentId
string
optional
Identifier of the reservation Business segment.
CompanyId
string
optional
Identifier of the Company on behalf of which the reservation was made.
TravelAgencyId
string
optional
Identifier of the Company that mediated the reservation.
RateId
string
required
Identifier of the reservation Rate.
AdultCount
number
required
Count of adults the reservation was booked for.
ChildCount
number
required
Count of children the reservation was booked for.
CustomerId
string
required
Unique identifier of the Customer who owns the reservation.
CompanionIds
array of string
required
Unique identifiers of Customers that will occupy the space.
Reservation state
Enquired - Confirmed neither by the customer nor enterprise.
Requested - Confirmed by the customer but not by the enterprise (waitlist).
Optional - Confirmed by enterprise but not by the guest (the enterprise is holding space for the guest).
Confirmed - Confirmed by both parties, before check-in.
Started - Checked in.
Processed - Checked out.
Canceled - Canceled.
Reservation origin
ChannelManager
Connector
Distributor
Import
ManualEmail
ManualWebsite
...       
Reservation group
Property
Type
​
Description
Id
string
required
Unique identifier of the reservation group.
Name
string
optional
Name of the reservation group, might be empty or same for multiple groups.
Order note
Property
Type
​
Description
Id
string
required
Unique identifier of the note.
OrderId
string
required
Unique identifier of the order or Reservation.
Text
string
required
Value of the note.
Type
string Order note type​
required
Type of the note.
CreatedUtc
string
required
Creation date and time of the note in UTC timezone in ISO 8601 format.
Order note type
General
ChannelManager
...
QrCode data
Property
Type
​
Description
ReservationId
string
required
Unique identifier of the reservation.
Data
string
required
Reservation data for QR code generation.
Get all reservations by ids
Returns all reservations with the specified unique identifiers.
Request
[PlatformAddress]/api/connector/v1/reservations/getAllByIds
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationIds": [
        "2b6212d4-55d5-47ba-b8d2-da07be15bce9",
        "0e2983e9-5ac1-4fd9-9f76-76565c1a9b67"
    ]
}
Property
Type
​
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.
ReservationIds
array of string
required
Unique identifiers of Reservations to be returned.
Extent
​Reservation extent​
optional
Extent of data to be returned.
Response
Same structure as in Get all reservations operation.
Get all reservations by customers
Returns all reservations owned by the specified customers.
Request
[PlatformAddress]/api/connector/v1/reservations/getAllByCustomers
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "CustomerIds": [
        "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a"
    ]
}
Property
Type
​
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.
CustomerIds
array of string
required
Unique identifiers of Customers owning the reservations.
Extent
​Reservation extent​
optional
Extent of data to be returned.
Response
Same structure as in Get all reservations operation.
Get all reservations by numbers
Returns all reservations with the specified confirmation numbers.
Request
[PlatformAddress]/api/connector/v1/reservations/getAllByNumbers
{
  "Numbers": ["7781"],
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "LanguageCode": null,
  "CultureCode": null
}
Property
Type
​
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.
Numbers
array of string
required
Confirmation numbers of Reservations.
Response
Same structure as in Get all reservations operation.
Get all reservation items
Returns all revenue items associated with the specified reservations.
Request
[PlatformAddress]/api/connector/v1/reservations/getAllItems
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationIds": [
        "e6ea708c-2a2a-412f-a152-b6c76ffad49b"
    ]
}
Property
Type
​
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.
ReservationIds
array of string
required
Unique identifiers of the Reservations.
Currency
string
optional
ISO-4217 code of the Currency the item costs should be converted to.
Response
{
    "Reservations": [
        {
            "Items": [
                {
                    "AccountingCategoryId": "0cf7aa90-736f-43e9-a7dc-787704548d86",
                    "Amount": {
                        "Currency": "GBP",
                        "NetValue": 16.67,
                        "GrossValue": 20
                        "TaxValues": [
                            {
                               "Code":"UK-S",
                               "Value": 3.33
                            }
                        ],
                    },
                    "BillId": null,
                    "ClosedUtc": "2017-02-41T10:41:54Z",
                    "ConsumptionUtc": "2016-03-10T13:00:00Z",
                    "CustomerId": "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a",
                    "Id": "784a29df-6196-4402-96a0-58695a881239",
                    "InvoiceId": null,
                    "Name": "Night 3/10/2016",
                    "Notes": null,
                    "OrderId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
                    "ProductId": null,
                    "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
                    "Type": "ServiceRevenue"
                }
            ],
            "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b"
        }
    ]
}
Property
Type
​
Description
Reservations
array of Reservation items​
required
The reservations with their items.
Reservation items
Property
Type
​
Description
ReservationId
string
required
Unique identifier of the Reservation.
Items
array of Accounting item​
required
The items associated with the reservation.
Price reservations
Returns prices of reservations with the specified parameters.
Request
[PlatformAddress]/api/connector/v1/reservations/price
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
    "Reservations": [
        {
            "Identifier": "1234",
            "StartUtc": "2018-01-01T14:00:00Z",
            "EndUtc": "2018-01-02T10:00:00Z",
            "AdultCount": 2,
            "ChildCount": 0,
            "RequestedCategoryId": "0a5da171-3663-4496-a61e-35ecbd78b9b1",
            "RateId": "33667cab-f17f-4089-ad07-c2cd50fa0df1",
            "Notes": "Test reservation",
            "ProductOrders": [
                {
                    "ProductId": "3dc5d79b-67ce-48ed-9238-47fcf5d1a59f"
                }
            ]
        }
    ]
}
Property
Type
​
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.
ServiceId
string
required
Unique identifier of the Service to be priced.
Reservations
array of Reservation parameters​
required
Parameters of the reservations to price. Note that CustomerId is not required when pricing reservations.
Response
{
    "ReservationPrices": [
        {
            "Identifier": "1234",
            "Total": {
                "Currency": "GBP",
                "NetValue": 20,
                "GrossValue": 23
                "TaxValues": [
                    {
                       "Code":"UK-S",
                       "Value": 3
                    }
                ],
            }
        }
    ]
}
Property
Type
​
Description
ReservationPrices
array of Reservation price​
required
The reservation prices.
Reservation price
Property
Type
​
Description
Identifier
string
optional
Identifier of the reservation within the transaction.
Total
​Currency value​
required
Total price of the reservation.
Add reservations
Adds the specified reservations as a single group. If GroupId is specified, adds the reservations to an already existing group.
Request
[PlatformAddress]/api/connector/v1/reservations/add
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
    "GroupId": null,
    "GroupName": null,
    "SendConfirmationEmail": true,
    "Reservations": [
        {
            "Identifier": "1234",
            "StartUtc": "2018-01-01T14:00:00Z",
            "EndUtc": "2018-01-02T10:00:00Z",
            "ReleasedUtc": null,
            "AdultCount": 2,
            "ChildCount": 0,
            "CustomerId": "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a",
            "BookerId": "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a",
            "RequestedCategoryId": "0a5da171-3663-4496-a61e-35ecbd78b9b1",
            "RateId": "33667cab-f17f-4089-ad07-c2cd50fa0df1",
            "TravelAgencyId": null,
            "CompanyId": null,
            "Notes": "Test reservation",
            "TimeUnitAmount": null,
            "TimeUnitPrices": [
                {
                    "Index": 0,
                    "Amount": {
                        "Currency": "GBP",
                        "GrossValue": 20,
                        "TaxCodes": [ "UK-S" ]
                    }
                },
                {
                    "Index": 1,
                    "Amount": {
                        "Currency": "GBP",
                        "GrossValue": 30,
                        "TaxCodes": [ "UK-S" ]
                    }
                }
            ],
            "ProductOrders": [
                {
                    "ProductId": "3dc5d79b-67ce-48ed-9238-47fcf5d1a59f"
                }
            ],
            "CreditCardId": "5d802a8f-3238-42b2-94be-ab0300ab2b6c"
        }
    ]
}
Property
Type
​
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.
ServiceId
string
required
Unique identifier of the Service to be reserved.
GroupId
string
optional
Unique identifier of the Reservation group where the reservations are added. If not specified, a new group is created.
GroupName
string
optional
Name of the Reservation group which the reservations are added to. If GroupId is specifed, this field is ignored. If not specified, the group name is automatically created.
Reservations
array of Reservation parameters​
required
Parameters of the new reservations.
SendConfirmationEmail
bool
optional
Wheter the confirmation email is sent. Default value is true.
CheckRateApplicability
bool
optional
Whether the rate applicability check is checked. Default value is true.
CheckOverbooking
bool
optional
Whether reservation overbooking is checked. Default value is true.
Reservation parameters
Property
Type
​
Description
Identifier
string
optional
Identifier of the reservation within the transaction.
State
string Reservation state​
optional
State of the newly created reservation (either Optional or Confirmed). If not specified, Confirmed is used.
StartUtc
string
required
Reservation start in UTC timezone in ISO 8601 format.
EndUtc
string
required
Reservation end in UTC timezone in ISO 8601 format.
ReleasedUtc
string
optional
Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format.
AdultCount
number
required
Count of adults the reservation is for.
ChildCount
number
required
Count of children the reservation is for.
CustomerId
string
required
Unique identifier of the Customer who owns the reservation.
BookerId
string
optional
Unique identifier of the Customer on whose behalf the reservation was made.
RequestedCategoryId
string
required
Identifier of the requested Space category.
RateId
string
required
Identifier of the reservation Rate.
TravelAgencyId
string
optional
Identifier of the Company that mediated the reservation.
CompanyId
string
optional
Identifier of the Company on behalf of which the reservation was made.
Notes
string
optional
Additional notes.
TimeUnitAmount
​Amount​
optional
Amount of each night of the reservation.
TimeUnitPrices
array of Time unit amount parameters​
optional
Prices for time units of the reservation. E.g. prices for the first or second night.
ProductOrders
array of Product order parameters​
optional
Parameters of the products ordered together with the reservation.
CreditCardId
string
optional
Identifier of Credit card belonging to Customer who owns the reservation.
Response
{
    "Reservations": [
        {
            "Identifier": "1234",
            "Reservation":
            {
                "AdultCount": 2,
                "AssignedSpaceId": "16ce4335-2198-408b-8949-9722894a42fb",
                "AssignedSpaceLocked": false,
                "BusinessSegmentId": "7760b5cb-a666-41bb-9758-76bf5d1df399",
                "CancelledUtc": null,
                "ChannelManager": "",
                "ChannelManagerGroupNumber": null,
                "ChannelManagerNumber": null,
                "ChannelNumber": null,
                "ChildCount": 0,
                "CompanionIds": [
                    "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a"
                ],
                "CompanyId": null,
                "CreditCardId": "5d802a8f-3238-42b2-94be-ab0300ab2b6c",
                "CreatedUtc": "2017-08-03T13:32:35Z",
                "CustomerId": "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a",
                "EndUtc": "2018-01-02T09:00:00Z",
                "GroupId": "4c79d393-53e1-45fd-bd24-2b0a36b4b3e6",
                "Id": "cfdfb9a1-b613-4cc1-b6c1-dfbb574c0f0e",
                "Number": "870",
                "Origin": "Manual",
                "RateId": "33667cab-f17f-4089-ad07-c2cd50fa0df1",
                "ReleasedUtc": null,
                "RequestedCategoryId": "0a5da171-3663-4496-a61e-35ecbd78b9b1",
                "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
                "StartUtc": "2018-01-01T14:00:00Z",
                "State": "Confirmed",
                "TravelAgencyId": null,
                "UpdatedUtc": "2017-08-03T13:32:35Z"
            }
        }
    ]
}
Property
Type
​
Description
Reservations
array of Added reservation​
required
The added reservations.
Added reservation
Property
Type
​
Description
Identifier
string
optional
Identifier of the reservation within the transaction.
Reservation
​Reservation​
required
The added reservation.
Update reservation
Updates information about a reservation. Note that if any of the fields are sent as null, it won't clear the field in Mews. If the Value within the object is sent as null, the field will be cleared in Mews.
Request
[PlatformAddress]/api/connector/v1/reservations/update
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "622605a9-2969-441f-9610-aa720099ae1c",
    "Reason": "Testing",
    "CheckOverbooking": true,
    "CheckRateApplicability": true,
    "StartUtc": {
        "Value": "2019-10-01T14:00:00Z"
    },
    "EndUtc": {
        "Value": "2019-10-03T10:00:00Z"
    },
    "AdultCount": {
        "Value": 2
    },
    "ChildCount": {
        "Value": 1
    },
    "ChannelNumber": null,
    "RequestedCategoryId": null,
    "TraveAgencyId": {
        "Value": null
    },
    "CompanyId": {
        "Value": "73ba34d1-f375-460c-bf2d-8a63e71677a6"
    },
    "BusinessSegmentId": null,
    "RateId": null,
    "BookerId": {
        "Value": "92923102-bf91-4a4a-8ee8-9dcb79c9d6de"
    },
    "TimeUnitPrices": {
        "Value": [
            {
                "Index": 0,
                "Amount": {
                    "Currency": "GBP",
                    "GrossValue": 20,
                    "TaxCodes": [ "UK-S" ]
                }
            },
            {
                "Index": 1,
                "Amount": {
                    "Currency": "GBP",
                    "GrossValue": 30,
                    "TaxCodes": [ "UK-S" ]
                }
            }
        ]
    },
     "CreditCardId": {
        "Value": "5d802a8f-3238-42b2-94be-ab0300ab2b6c"
    }
​
}
Property
Type
​
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.
ReservationId
string
required
Identifier of the reservation within the transaction.
Reason
string
optional
Reason for updating the reservation. Required when updating the price of the reservation.
CheckOverbooking
bool
optional
Whether reservation overbooking is checked. Default value is true.
CheckRateApplicability
bool
optional
Whether the rate applicability check is checked. Default value is true.
StartUtc
​String update value​
optional
Reservation start in UTC timezone in ISO 8601 format. (or null if the start time should not be updated).
EndUtc
​String update value​
optional
Reservation end in UTC timezone in ISO 8601 format. (or null if the end time should not be updated).
AdultCount
​Number update value​
optional
Count of adults the reservation is for. (or null if the adult count should not be updated).
ChildCount
​Number update value​
optional
Count of children the reservation is for. (or null if the child count should not be updated).
ChannelNumber
​String update value​
optional
Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number) (or null if the channel number should not be updated).
RequestedCategoryId
​String update value​
optional
Identifier of the requested Space category (or null if space category should not be updated).
TraveAgencyId
​String update value​
optional
Identifier of the Company that mediated the reservation (or null if travel agency should not be updated).
CompanyId
​String update value​
optional
Identifier of the Company on behalf of which the reservation was made (or null if company should not be updated).
BusinessSegmentId
​String update value​
optional
Identifier of the reservation Business segment (or null if the business segment should not be updated).
RateId
​String update value​
optional
Identifier of the reservation Rate (or null if the rate should not be updated).
BookerId
​String update value​
optional
Identifier of the Customer on whose behalf the reservation was made. (or null if the booker should not be updated).
TimeUnitPrices
​Time unit amount update value​
optional
Prices for time units of the reservation. E.g. prices for the first or second night. (or null if the unit amounts should not be updated).
CreditCardId
​String update value​
optional
Identifier of Credit card belonging to Customer who owns the reservation.  (or null if the credit card should not be updated).
String update value
Property
Type
​
Description
Value
string
optional
Value which is to be updated.
Number update value
Property
Type
​
Description
Value
number
optional
Value which is to be updated.
Bool update value
Property
Type
​
Description
Value
bool
optional
Value which is to be updated.
Time unit amount update value
Property
Type
​
Description
Value
array of Time unit amount parameters​
required
Value which is to be updated.
Time unit amount parameters
Property
Type
​
Description
Index
string
required
Index of the unit. Indexing starts with 0. E.g the first night of the reservation has index 0.
Amount
​Amount​
required
Amount of the unit.
Response
Same structure as in Get all reservations operation.
Confirm reservation
Marks a reservation as Confirmed. Succeeds only if all confirmation conditions are met (the reservation has the Optional state).
Request
[PlatformAddress]/api/connector/v1/reservations/confirm
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b"
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to confirm.
SendConfirmationEmail
bool
optional
Wheter the confirmation email is sent. Default value is true.
Response
{}
Start reservation
Marks a reservation as Started (= checked in). Succeeds only if all starting conditions are met (the reservation has the Confirmed state, does not have start set to future, has an inspected room assigned etc).
Request
[PlatformAddress]/api/connector/v1/reservations/start
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b"
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to start.
Response
{}
Process reservation
Marks a reservation as Processed (= checked out). Succeeds only if all processing conditions are met (the reservation has the Started state, balance of all reservation members is zero etc).
Request
[PlatformAddress]/api/connector/v1/reservations/process
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
    "CloseBills": false,
    "AllowOpenBalance": false,
    "Notes": null
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to process.
CloseBills
bool
optional
Whether closable bills of the reservation members should be automatically closed.
AllowOpenBalance
bool
optional
Whether non-zero consumed balance of all reservation members is allowed.
Notes
string
optional
Notes of the event, required if AllowOpenBalance set to true.
Response
{}
Cancel reservation
Cancels a reservation. Succeeds only if the reservation is cancellable.
Request
[PlatformAddress]/api/connector/v1/reservations/cancel
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
    "ChargeCancellationFee": true,
    "Notes": "Cancellation through Connector API"
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to cancel.
ChargeCancellationFee
boolean
required
Whether cancellation fees should be charged according to rate conditions.
Notes
string
required
Addiotional notes describing the cancellation.
Response
{}
Update reservation customer
Updates customer of a reservation.
Request
[PlatformAddress]/api/connector/v1/reservations/updateCustomer
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "209d984d-4985-4efb-96ec-f6591fc597bf",
    "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98"
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to be updated.
CustomerId
string
required
Unique identifier of the Customer.
Response
{}
Update reservation interval
Updates reservation interval (start, end or both).
Request
[PlatformAddress]/api/connector/v1/reservations/updateInterval
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "209d984d-4985-4efb-96ec-f6591fc597bf",
    "StartUtc": "2017-08-12T15:00:00Z",
    "EndUtc": "2017-08-15T12:00:00Z",
    "ChargeCancellationFee": false
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to be updated.
StartUtc
string
optional
New reservation start in UTC timezone in ISO 8601 format.
EndUtc
string
optional
New reservation end in UTC timezone in ISO 8601 format.
ChargeCancellationFee
boolean
required
Whether cancellation fee should be charged for potentially canceled nights.
Response
{}
Update reservation space
Updates reservation allocation to space, e.g. to different room.
Request
[PlatformAddress]/api/connector/v1/reservations/updateSpace
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
    "SpaceId": "5ee074b1-6c86-48e8-915f-c7aa4702086f"
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to be reassigned.
SpaceId
string
required
Unique identifier of the Space where the reservation should be assigned.
Response
{}
Update reservation requested category
Updates reservation category requested by the customer to a different one.
Request
[PlatformAddress]/api/connector/v1/reservations/updateRequestedCategory
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
    "CategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f",
    "Reprice": false,
    "Overbook": true
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation to be updated.
CategoryId
string
required
Unique identifier of the Space category.
Reprice
bool
required
Whether reservation should be repriced according to new category pricing.
Overbook
bool
optional
Whether the overbooking is enabled. Default value is true.
Response
{}
Add reservation companion
Adds a customer as a companion to the reservation. Succeeds only if there is space for the new companion (count of current companions is less than AdultCount + ChildCount).
Request
[PlatformAddress]/api/connector/v1/reservations/addCompanion
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
    "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98"
}
Property
Type
​
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.
ReservationId
string
required
Unique identifier of the Reservation.
CustomerId
string
required
Unique identifier of the Customer.
Response
{}
Delete reservation companion
Removes customer companionship from the reservation. Note that the customer profile stays untouched, only the relation between the customer and reservation is deleted.
Request
[PlatformAddress]/api/connector/v1/reservations/deleteCompanion
{
Property	Type		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.
`TimeFilter`	string Reservation time filter	optional	Time filter of the interval. If not specified, reservations `Colliding` with the interval are returned.
`StartUtc`	string	required	Start of the interval in UTC timezone in ISO 8601 format.
`EndUtc`	string	required	End of the interval in UTC timezone in ISO 8601 format.
`States`	array of string Reservation state	optional	States the reservations should be in. If not specified, reservations in `Confirmed`, `Started` or `Processed` states are returned.
`Extent`	Reservation extent	optional	Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned. If not specified, `Reservations`, `Groups` and `Customers` is used as the default extent.
`Currency`	string	optional	ISO-4217 code of the Currency the item costs should be converted to.