Connector API
Search…
Services

Get all services

Returns all services offered by the enterprise.

Request

[PlatformAddress]/api/connector/v1/services/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0"
5
}
Copied!
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.

Response

1
{
2
"Services": [
3
{
4
"Id": "fc79a518-bc69-45b8-93bd-83326201bd14",
5
"IsActive": true,
6
"Name": "Restaurant",
7
"Data": {
8
"Discriminator": "Additional",
9
"Value": {
10
"Promotions": {
11
"BeforeCheckIn": false,
12
"AfterCheckIn": false,
13
"DuringStay": false,
14
"BeforeCheckOut": false,
15
"AfterCheckOut": false,
16
"DuringCheckOut": false
17
}
18
}
19
}
20
},
21
{
22
"Id": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
23
"IsActive": true,
24
"Name": "Accommodation",
25
"Data": {
26
"Discriminator": "Bookable",
27
"Value": {
28
"StartOffset": "P0M0DT15H0M0S",
29
"EndOffset": "P0M0DT12H0M0S",
30
"OccupancyStartOffset": "P0M0DT15H0M0S",
31
"OccupancyEndOffset": "P0M0DT12H0M0S",
32
"TimeUnit": "Day"
33
}
34
}
35
}
36
]
37
}
Copied!
Property
Type
Contract
Description
Services
array of Service
required
Services offered by the enterprise.

Service

Property
Type
Contract
Description
Id
string
required
Unique identifier of the service.
IsActive
boolean
required
Whether the service is still active.
Name
string
required
Name of the service.
Data
required
Additional information about the specific service.

Service data

Property
Type
Contract
Description
Discriminator
required
Determines type of value.
Value
object
required
Structure of object depends on Service data discriminator.

Service data discriminator

  • Bookable - Data specific to a bookable service.
  • Additional - Data specific to an additional service.

Bookable service data

Property
Type
Contract
Description
StartOffset
string
required
Offset from the start of the time unit defining the default start of the service orders in ISO 8601 duration format.
EndOffset
string
required
Offset from the end of the time unit defining the default end of the service orders in ISO 8601 duration format.
OccupancyStartOffset
string
required
Offset from the start of the time unit defining the occupancy start of the service in ISO 8601 duration format that is considered regarding the availability and reporting.
OccupancyEndOffset
string
required
Offset from the end of the time unit defining the occupancy end of the service in ISO 8601 duration format that is considered regarding the availability and reporting.
TimeUnit
Time unit
required
Time unit of the service.
Time units represent a fixed, finite time interval: a minute, a day, a month, etc. A Time unit defines the operable periods for a bookable service. We currently only support the Day unit. We think of the daily time unit as the physical time unit that starts at midnight and ends at midnight the following day.
Start offsets are anchored to the start of the time unit and end offsets are anchored to the end of the time unit. StartOffset and EndOffset define the default start and end of the service (so, the service orders). OccupancyStartOffset and OccupancyEndOffset define the time where the space is considered occupied in Mews.
Positive end offsets of the daily time unit define the nightly service as depicted in the diagram below.
Negative or zero end offsets of the daily time unit define the daily service as depicted on the picture below.

Time unit

  • Day
  • ...

Additional service data

Property
Type
Contract
Description
Promotions
required
Promotions of the service.
Promotions
Property
Type
Contract
Description
BeforeCheckIn
boolean
required
Whether it can be promoted before check-in.
AfterCheckIn
boolean
required
Whether it can be promoted after check-in.
DuringStay
boolean
required
Whether it can be promoted during stay.
BeforeCheckOut
boolean
required
Whether it can be promoted before check-out.
AfterCheckOut
boolean
required
Whether it can be promoted after check-out.
DuringCheckOut
boolean
required
Whether it can be promoted during check-out.

Get all availability blocks

This feature is being actively developed, features and behavior of this operation might change at short notice.
Returns all availability blocks filtered by services, unique identifiers and other filters.

Request

[PlatformAddress]/api/connector/v1/availabilityBlocks/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"AvailabilityBlockIds": [
6
"aaaa654a4a94-4f96-9efc-86da-bd26d8db"
7
],
8
"ServiceIds": [
9
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
10
],
11
"CreatedUtc" : {
12
"StartUtc": "2020-11-04T00:00:00Z",
13
"EndUtc": "2020-11-05T00:00:00Z"
14
},
15
"UpdatedUtc" : {
16
"StartUtc": "2020-11-04T00:00:00Z",
17
"EndUtc": "2020-11-05T00:00:00Z"
18
},
19
"CollidingUtc" : {
20
"StartUtc": "2020-11-05T00:00:00Z",
21
"EndUtc": "2020-11-05T00:00:00Z"
22
},
23
"States": [
24
"Confirmed"
25
],
26
"ExternalIdentifiers": [
27
"Block-0001"
28
],
29
"Extent": {
30
"AvailabilityBlocks": true,
31
"Adjustments": true,
32
"ServiceOrders": false
33
}
34
}
Copied!
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.
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
optional, max length 3 months
Interval in which the Availability blocks were created.
UpdatedUtc
optional, max length 3 months
Interval in which the Availability blocks were updated.
CollidingUtc
optional, max length 3 months
Interval in which the Availability blocks are active.
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.
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.

Response

1
{
2
"AvailabilityBlocks": [
3
{
4
"Id": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
5
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
6
"RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
7
"VoucherId": null,
8
"BookerId": null,
9
"Budget": {
10
"Currency": "USD",
11
"Value": 48.0
12
},
13
"State": "Confirmed",
14
"ReservationPurpose": "Leisure",
15
"CreatedUtc": "2021-10-11T13:32:32Z",
16
"UpdatedUtc": "2021-10-11T13:32:32Z",
17
"StartUtc": "2021-10-14T00:00:00Z",
18
"EndUtc": "2021-10-17T00:00:00Z",
19
"ReleasedUtc": "2021-10-13T00:00:00Z",
20
"ExternalIdentifier": "Block-0001"
21
"Name": "Wedding group",
22
"Notes": "Have a nice stay"
23
}
24
],
25
"ServiceOrders": [
26
{
27
"Id": "5281b551-bd90-4def-b211-acbd00d3ac8c",
28
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
29
"GroupId": "edad92db-0b60-4b91-a090-acbd00d3ac75",
30
"Number": "61",
31
"ChannelNumber": "68845CDD-1340-49B5-9071-ACBD00B1D091",
32
"ChannelManagerNumber": null,
33
"ChannelManagerGroupNumber": null,
34
"ChannelManager": null,
35
"State": "Confirmed",
36
"Origin": "Connector",
37
"CreatedUtc": "2020-11-05T12:50:40Z",
38
"UpdatedUtc": "2020-11-06T07:59:19Z",
39
"CancelledUtc": null,
40
"StartUtc": "2020-11-05T00:00:00Z",
41
"EndUtc": "2020-11-06T00:00:00Z",
42
"ReleasedUtc": null,
43
"RequestedCategoryId": "1268c440-21c5-415d-bf58-ac87008b2bda",
44
"AssignedResourceId": "f97a6b96-b17f-421f-9b97-ac87008b3324",
45
"AssignedResourceLocked": false,
46
"BusinessSegmentId": null,
47
"CompanyId": null,
48
"TravelAgencyId": null,
49
"AvailabilityBlockId": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
50
"RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
51
"VoucherId": null,
52
"AdultCount": 2,
53
"ChildCount": 0,
54
"CustomerId": "c2730cbc-53ca-440d-8b30-ac87008b30af",
55
"CompanionIds": []
56
}
57
],
58
"Adjustments": [
59
{
60
"AvailabilityBlockId": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
61
"ResourceCategoryId": "1268c440-21c5-415d-bf58-ac87008b2bda",
62
"StartUtc": "2020-11-05T23:00:00Z",
63
"EndUtc": "2020-11-06T23:00:00Z",
64
"UnitCount": 6
65
}
66
]
67
}
Copied!
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
optional
Availability adjustments of availability blocks.

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.
Budget
optional
The tentative budget for the total price of reservations in the block.
State
required
State of the availability block.
ReservationPurpose
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.
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.
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.

Availability block adjustment

Property
Type
Contract
Description
AvailabilityBlockId
string
required
Unique identifier of the Availability block whose availability is updated.
ResourceCategoryId
string
required
Unique identifier of the Resource category whose availability is updated.
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.
UnitCount
string
required
Adjustment value applied on the interval.

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.

Request

[PlatformAddress]/api/connector/v1/availabilityBlocks/add
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"AvailabilityBlocks": [
6
{
7
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
8
"RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
9
"VoucherCode": null,
10
"Name": "Mr. Smith's block",
11
"StartUtc": "2020-11-05T00:00:00Z",
12
"EndUtc": "2020-11-06T00:00:00Z",
13
"ReleasedUtc": "2020-11-04T00:00:00Z",
14
"ExternalIdentifier": "Block-0001",
15
"Budget": {
16
"Value": 500,
17
"Currency": "EUR"
18
},
19
"ReservationPurpose": null,
20
"Notes": null,
21
"State": "Confirmed"
22
}
23
]
24
}
Copied!
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.
AvailabilityBlocks
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.
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.
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
optional
The tentative budget for the total price of reservations.
ReservationPurpose
optional
The purpose of the block.
Notes
string
optional
Additional notes of the block.
State
required
State of the availability block.

Response

1
{
2
"AvailabilityBlocks": [
3
{
4
"Id": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
5
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
6
"RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
7
"StartUtc": "2020-11-05T00:00:00Z",
8
"EndUtc": "2020-11-06T00:00:00Z",
9
"ReleasedUtc": "2020-11-04T00:00:00Z",
10
"ExternalIdentifier": "Block-0001"
11
}
12
]
13
}
Copied!
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
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"AvailabilityBlocks": [
6
{
7
"AvailabilityBlockId": "aaaa654a4a94-4f96-9efc-86da-bd26d8db",
8
"Name": {"Value": "Mr. John Snow block"},
9
"StartUtc":{"Value": "2021-07-05T00:00:00Z"},
10
"EndUtc":{"Value": "2021-07-15T00:00:00Z"},
11
"ReleasedUtc":{"Value": "2021-07-04T00:00:00Z"},
12
"ExternalIdentifier": {"Value": "123456798"}
13
}
14
]
15
}
Copied!
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.
AvailabilityBlocks
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
optional
The name of the block (or null if the name should not be updated).
StartUtc
required
Start of the interval in UTC timezone in ISO 8601 format (or null if the start time should not be updated).
EndUtc
required
End of the interval in UTC timezone in ISO 8601 format (or null if the end time should not be updated).
ReleasedUtc
required
The moment when the block and its availability is released (or null if the released time should not be updated).
ExternalIdentifier
optional, max 255 characters
Identifier of the block from external system (or null if the identifier should not be updated).

Response

1
{}
Copied!

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
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"AvailabilityBlockIds": [
6
"e5a4654a4a94-86da-4f96-9efc-bd26d8db",
7
"aaaa654a4a94-4f96-9efc-86da-bd26d8db"
8
]
9
}
Copied!
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.
AvailabilityBlockIds
array of string
required, max 1000 items
Unique identifier of the Availability block to delete.

Response

1
{}
Copied!

Get service availability

Returns availability of a bookable service in the specified interval including applied availability adjustments. The response contains availability for all dates that the specified interval intersects.

Request

[PlatformAddress]/api/connector/v1/services/getAvailability
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
6
"StartUtc":"2017-01-01T00:00:00.000Z",
7
"EndUtc":"2017-01-03T00:00:00.000Z"
8
}
Copied!
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.
ServiceId
string
required
Unique identifier of the Service whose availability should be returned.
StartUtc
string
required, max length 3 months
Start of the interval in UTC timezone in ISO 8601 format.
EndUtc
string
required, max length 3 months
End of the interval in UTC timezone in ISO 8601 format.

Response

1
{
2
"CategoryAvailabilities": [
3
{
4
"Availabilities": [ 6, 7, 5 ],
5
"Adjustments ": [ 0, 1, -1 ],
6
"CategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f"
7
},
8
{
9
"Availabilities": [ 7, 7, 7 ],
10
"Adjustments ": [ 1, 0, -1 ],
11
"CategoryId": "a0a7a5c5-c4ef-494a-8b34-6cca97629076"
12
}
13
],
14
"DatesUtc": [
15
"2016-12-31T23:00:00Z",
16
"2017-01-01T23:00:00Z",
17
"2017-01-02T23:00:00Z"
18
]
19
}
Copied!
Property
Type
Contract
Description
CategoryAvailabilities
required
Resource category availabilities.
DatesUtc
array of string
required
Covered dates in UTC timezone in ISO 8601 format.

Resource category availability

Property
Type
Contract
Description
CategoryId
string
required
Unique identifier of the Resource category.
Availabilities
array of number
required
Absolute availabilities of the resource category in the covered dates.
Adjustments
array of number
required
Relative availability adjustments set for resource category in the covered dates.

Update service availability

Updates the number of available resources in Resource category by a certain amount (relative adjustment). Note that availabilities are defined daily, so when the server receives the UTC interval, it first converts it to enterprise timezone and updates the price on all dates that the interval intersects. It's not allowed to update past availabilities outside of EditableHistoryInterval, future updates are allowed for up to 5 years.

Request

[PlatformAddress]/api/connector/v1/services/updateAvailability
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
6
"AvailabilityUpdates": [
7
{
8
"StartUtc": "2020-10-05T00:00:00Z",
9
"EndUtc": "2020-10-05T00:00:00Z",
10
"AvailabilityBlockId": "23e85a44-d95a-4dcf-9f36-acb000b10abe",
11
"ResourceCategoryId": "46bc1498-38cf-4d03-b144-aa69012f5d50",
12
"UnitCountAdjustment": { "Value": 6 }
13
},
14
{
15
"StartUtc": "2020-10-07T00:00:00Z",
16
"EndUtc": "2020-10-08T00:00:00Z",
17
"ResourceCategoryId": "46bc1498-38cf-4d03-b144-aa69012f5d50",
18
"UnitCountAdjustment": { }
19
}
20
]
21
}
Copied!
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.
ServiceId
string
required
Unique identifier of the Service to update.
AvailabilityUpdates
required, max 1000 items
Availability updates.

Availability update

Property
Type
Contract
Description
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.
AvailabilityBlockId
string
optional
Unique identifier of the Availability block whose availability to update.
ResourceCategoryId
string
required
Unique identifier of the Resource category whose availability to update.
UnitCountAdjustment
required
Adjustment value to be applied on the interval, can be both positive and negative (relative adjustment, not an absolute number). If specified without Value parameter, removes all adjustments within the interval.

Response

1
{}
Copied!

Get all products

Returns all products offered together with the specified services.

Request

[PlatformAddress]/api/connector/v1/products/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"ServiceIds": [
6
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
7
]
8
}
Copied!
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.
ServiceIds
array of string
required, max 1000 items
Unique identifiers of the Services.

Response

1
{
2
"Products": [
3
{
4
"Id": "198bc308-c1f2-4a1c-a827-c41d99d52f3d",
5
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
6
"CategoryId": null,
7
"IsActive": true,
8
"Name": "Breakfast",
9
"ExternalName": "Breakfast",
10
"ShortName": "BFST",
11
"Description": "Nice continental breakfast.",
12
"Charging": "PerPersonPerTimeUnit",
13
"Posting": "Once",
14
"Promotions": {
15
"BeforeCheckIn": false,
16
"AfterCheckIn": false,
17
"DuringStay": false,
18
"BeforeCheckOut": false,
19
"AfterCheckOut": false,
20
"DuringCheckOut": false
21
},
22
"Classifications": {
23
"Food": false,
24
"Beverage": false,
25
"Wellness": false,
26
"CityTax": false
27
},
28
"Price": {
29
"Currency": "GBP",
30
"NetValue": 7.5,
31
"GrossValue": 9
32
"TaxValues": [
33
{
34
"Code": "UK-S",
35
"Value": 1.50
36
}
37
],
38
}
39
}
40
]
41
}
Copied!
Property
Type
Contract
Description
Products
array of Product
required
Products offered with the service.

Product

Property
Type
Contract
Description
Id
string
required
Unique identifier of the product.
ServiceId
string
required
Unique identifier of the Service.
CategoryId
string
optional
Unique identifier of the Product category.
IsActive
boolean
required
Whether the product is still active.
Name
string
required
Name of the product.
ExternalName
string
required
Name of the product meant to be displayed to customer.
ShortName
string
required
Short name of the product.
Description
string
optional
Description of the product.
Charging
required
Charging of the product.
Posting
string Product posting
required
Posting of the product.
Promotions
required
Promotions of the service.
Classifications
required
Classifications of the service.
Price
required
Price of the product.

Product charging

  • Once
  • PerTimeUnit
  • PerPersonPerTimeUnit
  • PerPerson

Product posting

  • Once
  • Daily

Product classifications

Property
Type
Contract
Description
Food
boolean
required
Product is classified as food.
Beverage
boolean
required
Product is classified as beverage.
Wellness
boolean
required
Product is classified as wellness.
CityTax
boolean
required
Product is classified as city tax.

Get all rules

Returns all rules applied with the reservations.

Request

[PlatformAddress]/api/connector/v1/rules/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"ServiceIds": [
6
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
7
],
8
"Extent":
9
{
10
"RuleActions": true,
11
"Rates": true,
12
"RateGroups": true,
13
"ResourceCategories": true,
14
"BusinessSegments": true
15
}
16
}
Copied!
Property
Type
Contract
Description