Services

Get all services

Returns all services offered by the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/services/getAll

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "ServiceIds": [
    "fc79a518-bc69-45b8-93bd-83326201bd14",
    "bd26d8db-86da-4f96-9efc-e5a4654a4a94"
  ],
  "UpdatedUtc": {
    "StartUtc": "2020-01-05T00:00:00Z",
    "EndUtc": "2020-01-10T00:00:00Z"
  },
  "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.
ServiceIds	array of string	optional, max 1000 items	Unique identifiers of Services.
UpdatedUtc	Time interval	optional, max length 3 months	Interval in which Services were updated.
Limitation	Limitation	required	Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "Services": [
    {
      "Id": "fc79a518-bc69-45b8-93bd-83326201bd14",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreatedUtc": "2023-10-01T11:48:57Z",
      "UpdatedUtc": "2023-10-28T11:48:57Z",
      "IsActive": true,
      "Name": "Restaurant",
      "Options": {
        "BillAsPackage": false
      },
      "Data": {
        "Discriminator": "Additional",
        "Value": {
          "Promotions": {
            "BeforeCheckIn": false,
            "AfterCheckIn": false,
            "DuringStay": false,
            "BeforeCheckOut": false,
            "AfterCheckOut": false,
            "DuringCheckOut": false
          }
        }
      },
      "ExternalIdentifier": "SVCE-Restaurant"
    },
    {
      "Id": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
      "CreatedUtc": "2023-10-01T11:48:57Z",
      "UpdatedUtc": "2023-10-28T11:48:57Z",
      "IsActive": true,
      "Name": "Accommodation",
      "Options": {
        "BillAsPackage": true
      },
      "Data": {
        "Discriminator": "Bookable",
        "Value": {
          "StartOffset": "P0M0DT15H0M0S",
          "EndOffset": "P0M0DT12H0M0S",
          "OccupancyStartOffset": "P0M0DT15H0M0S",
          "OccupancyEndOffset": "P0M0DT12H0M0S",
          "TimeUnitPeriod": "Day"
        }
      },
      "ExternalIdentifier": "SVCE-Accomm"
    }
  ],
  "Cursor": "bd26d8db-86da-4f96-9efc-e5a4654a4a94"
}

Property	Type	Contract	Description
Services	array of Service	required	Services offered by the enterprise.
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.

Service

Property	Type	Contract	Description
Id	string	required	Unique identifier of the service.
EnterpriseId	string	required	Unique identifier of the Enterprise.
IsActive	boolean	required	Whether the service is still active.
Names	Localized text	required	All translations of the name.
Options	Service options	required	Options of the service.
Ordering	integer	required	Order value for presentation purposes.
Data	Service data	required	Additional information about the specific service.
ExternalIdentifier	string	optional, max length 255 characters	Identifier of the service from external system.
CreatedUtc	string	required	Creation date and time of the service in UTC timezone in ISO 8601 format.
UpdatedUtc	string	required	Last update date and time of the service in UTC timezone in ISO 8601 format.
Name	string	required	Name of the service. Deprecated! Use Names instead
StartTime	string	optional	Deprecated!
EndTime	string	optional	Deprecated!
Promotions	Promotions	optional	Deprecated! Use Promotions in Data instead.
Type	string	optional	Deprecated!

Service options

Options of the service.

Property	Type	Contract	Description
BillAsPackage	boolean	required	Products should be displayed as a single package instead of individual items.

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.

Service data

Additional information about the specific service.

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

Service data discriminator

• Bookable

• Additional

Bookable service data

Property	Type	Contract	Description
StartOffset	string	required	Offset from the start of the time unit which defines the default start of the service; expressed in ISO 8601 duration format.
EndOffset	string	required	Offset from the end of the time unit which defines the default end of the service; expressed in ISO 8601 duration format.
OccupancyStartOffset	string	required	Offset from the start of the time unit which defines the occupancy start of the service; expressed in ISO 8601 duration format. 'Occupancy start' is used for availability and reporting purposes, it implies the time at which the booked resource is considered occupied.
OccupancyEndOffset	string	required	Offset from the end of the time unit which defines the occupancy end of the service; expressed in ISO 8601 duration format. 'Occupancy end' is used for availability and reporting purposes, it implies the time at which the booked resource is no longer considered occupied.
TimeUnitPeriod	Time unit period	required	The length of time or period represented by a time unit, for which the service can be booked.
TimeUnit	Time unit period	required	Deprecated! Use TimeUnitPeriod instead.

Time unit period

• Day

• Month

• Hour

Additional service data

Property	Type	Contract	Description
Promotions	Promotions	required	Promotions of the service.

Get service availability (ver 2024-01-22)

Restricted!

This operation is currently in beta-test and as such it is subject to change.

Returns selected availability and occupancy metrics of a bookable service for a specified time interval, similar to the availability & occupancy report. Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC will result in one time unit for 2nd Jan, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC will result in two time units for 2nd Jan and 3rd Jan (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see Time unit.

Request

[PlatformAddress]/api/connector/v1/services/getAvailability/2024-01-22

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
  "FirstTimeUnitStartUtc": "2024-02-01T23:00:00.000Z",
  "LastTimeUnitStartUtc": "2024-02-05T23:00:00.000Z",
  "Metrics": [
    "OutOfOrderBlocks",
    "PublicAvailabilityAdjustment",
    "OtherServiceReservationCount",
    "Occupied",
    "ConfirmedReservations",
    "OptionalReservations",
    "BlockAvailability",
    "AllocatedBlockAvailability",
    "UsableResources",
    "ActiveResources"
  ]
}

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.
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. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months.
Metrics	array of Service availability metrics	required	Set of Service availability metrics to be returned.

Service availability metrics

• OutOfOrderBlocks - Number of resources that are out of order for the resource category (see Resource Block).

• PublicAvailabilityAdjustment - Number of resources marked as manual availability adjustments.

• OtherServiceReservationCount - Number of resources occupied by another service.

• Occupied - Number of bookings that have been assigned to the resource category (i.e. reservations and blocks).

• ConfirmedReservations - Number of confirmed reservations that have been assigned to the resource category.

• OptionalReservations - Number of optional reservations that have been assigned to the resource category.

• BlockAvailability - Number of blocked resources (from an availability block / allotment).

• AllocatedBlockAvailability - Number of blocked resources that are in a deducting state (from an availability block / allotment).

• UsableResources - Number of usable resources (i.e. which are not out of order).

• ActiveResources - Number of active resources.

Response

{
  "TimeUnitStartsUtc": [
    "2024-01-31T23:00:00Z",
    "2024-02-01T23:00:00Z",
    "2024-02-02T23:00:00Z",
    "2024-02-03T23:00:00Z",
    "2024-02-04T23:00:00Z"
  ],
  "ResourceCategoryAvailabilities": [
    {
      "ResourceCategoryId": "d1801d11-fe8d-404b-a26f-af170189605a",
      "Metrics": {
        "OutOfOrderBlocks": [0, 1, 0, 0, 1],
        "PublicAvailabilityAdjustment": [7, 5, 4, 3, 4],
        "OtherServiceReservationCount": [0, 0, 1, 0, 0],
        "Occupied": [7, 5, 4, 3, 4],
        "ConfirmedReservations": [7, 5, 4, 3, 4],
        "OptionalReservations": [0, 2, 0, 0, 1],
        "BlockAvailability": [0, 0, 1, 0, 0],
        "AllocatedBlockAvailability": [0, 0, 0, 1, 0],
        "UsableResources": [8, 8, 8, 8, 8],
        "ActiveResources": [8, 8, 8, 8, 8]
      }
    }
  ]
}

Property	Type	Contract	Description
TimeUnitStartsUtc	array of string	required	Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
ResourceCategoryAvailabilities	array of Resource category availability (ver 2024-01-22)	required	Resource category availabilities. Can be empty if no resource categories are assigned to the service.

Resource category availability (ver 2024-01-22)

Property	Type	Contract	Description
ResourceCategoryId	string	required	Unique identifier of the Resource category.
Metrics	Dictionary of integer arrays	required	Dictionary keys are names of Service availability metrics, values are arrays of integers with metric values for corresponding time unit in TimeUnitStartsUtc.

Get service availability

Returns availability of a bookable service for a specified time interval including applied availability adjustments. Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC will result in one price for 2nd Jan, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC will result in two prices for 2nd Jan and 3rd Jan (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see Time unit.

Request

[PlatformAddress]/api/connector/v1/services/getAvailability

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
  "FirstTimeUnitStartUtc": "2017-01-01T23:00:00.000Z",
  "LastTimeUnitStartUtc": "2017-01-03T23:00:00.000Z"
}

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.
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. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months.
StartUtc	string	optional	Deprecated!
EndUtc	string	optional	Deprecated!

Response

{
  "CategoryAvailabilities": [
    {
      "Availabilities": [6, 7, 5],
      "Adjustments ": [0, 1, -1],
      "CategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f"
    },
    {
      "Availabilities": [7, 7, 7],
      "Adjustments ": [1, 0, -1],
      "CategoryId": "a0a7a5c5-c4ef-494a-8b34-6cca97629076"
    }
  ],
  "TimeUnitStartsUtc": [
    "2017-01-01T23:00:00Z",
    "2017-01-02T23:00:00Z",
    "2017-01-03T23:00:00Z"
  ]
}

Property	Type	Contract	Description
TimeUnitStartsUtc	array of string	required	Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
CategoryAvailabilities	array of Resource category availability	required	Resource category availabilities.
DatesUtc	array of string	optional	Deprecated!

Resource category availability

Property	Type	Contract	Description
CategoryId	string	required	Unique identifier of the Resource category.
Availabilities	array of integer	required	Absolute availabilities of the resource category in the covered dates.
Adjustments	array of integer	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 per time unit, so when the server receives the UTC interval, it first converts it to enterprise timezone and updates the availability on all time units 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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
  "AvailabilityUpdates": [
    {
      "FirstTimeUnitStartUtc": "2020-10-05T23:00:00Z",
      "LastTimeUnitStartUtc": "2020-10-05T23:00:00Z",
      "AvailabilityBlockId": "23e85a44-d95a-4dcf-9f36-acb000b10abe",
      "ResourceCategoryId": "46bc1498-38cf-4d03-b144-aa69012f5d50",
      "UnitCountAdjustment": {
        "Value": 6
      }
    },
    {
      "FirstTimeUnitStartUtc": "2020-10-07T23:00:00Z",
      "LastTimeUnitStartUtc": "2020-10-08T23:00:00Z",
      "ResourceCategoryId": "46bc1498-38cf-4d03-b144-aa69012f5d50",
      "UnitCountAdjustment": {}
    }
  ]
}

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	array of Availability update	required, max 1000 items	Availability updates.

Availability update

Property	Type	Contract	Description
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. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months.
ResourceCategoryId	string	required	Unique identifier of the Resource category whose availability to update.
UnitCountAdjustment	Number update value	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.
AvailabilityBlockId	string	optional	Unique identifier of the Availability block whose availability to update.
PaxCounts	array of PaxCount	optional, max 5 items	Collection of predicted occupancy of availability adjustments. Relates how many adjustments are assigned to each count of guests.
StartUtc	string	optional	Deprecated!
EndUtc	string	optional	Deprecated!

PaxCount

Property	Type	Contract	Description
PersonCount	integer	required	Predicted guest count that will be assigned to the Resource. The guest count must fit within the Resource Category maximum capacity.
UnitCount	integer	required	Positive number of adjustments that are assigned to PersonCount. The sum of all UnitCount in PaxCounts should match the adjustment value applied to the interval.

Response

{}