Connector API
Search…
⌃K

Products

Get all products

Returns all products offered together with the specified services.

Request

[PlatformAddress]/api/connector/v1/products/getAll
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ServiceIds": [
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
],
"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.
ServiceIds
array of string
required, max 1000 items
Unique identifiers of the Services.
Limitation
required
Limitation on the quantity of products returned.

Response

{
"Products": [
{
"Id": "198bc308-c1f2-4a1c-a827-c41d99d52f3d",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"CategoryId": null,
"IsActive": true,
"Name": "Breakfast",
"ExternalName": "Breakfast",
"ShortName": "BFST",
"Description": "Nice continental breakfast.",
"ChargingMode": "PerPersonPerTimeUnit",
"PostingMode": "Once",
"Options": {
"BillAsPackage": false
},
"Promotions": {
"BeforeCheckIn": false,
"AfterCheckIn": false,
"DuringStay": false,
"BeforeCheckOut": false,
"AfterCheckOut": false,
"DuringCheckOut": false
},
"Classifications": {
"Food": false,
"Beverage": false,
"Wellness": false,
"CityTax": false
},
"UnitAmount": {
"GrossValue": 25,
"Currency": "EUR",
"TaxValues": [
{
"Code": "FR-T"
}
]
}
}
],
"CustomerProducts" : [
{
"Id": "198bc308-c1f2-4a1c-a827-c41d99d52f3d",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"CategoryId": null,
"IsActive": true,
"Name": "Breakfast",
"ExternalName": "Breakfast",
"ShortName": "BFST",
"Description": "Nice continental breakfast.",
"ChargingMode": "PerPersonPerTimeUnit",
"PostingMode": "Once",
"Options": {
"BillAsPackage": false
},
"Promotions": {
"BeforeCheckIn": false,
"AfterCheckIn": false,
"DuringStay": false,
"BeforeCheckOut": false,
"AfterCheckOut": false,
"DuringCheckOut": false
},
"Classifications": {
"Food": false,
"Beverage": false,
"Wellness": false,
"CityTax": false
},
"UnitAmount": {
"GrossValue": 25,
"Currency": "EUR",
"TaxValues": [
{
"Code": "FR-T"
}
]
}
}
],
"Cursor" : "198bc308-c1f2-4a1c-a827-c41d99d52f3d"
}
Property
Type
Contract
Description
Products
array of Product
required
Products offered with the service.
CustomerProducts
array of Product
required
Products offered specifically to customers.
Cursor
string
required
Unique identifier of the last and hence oldest product returned. This can be used in Limitation in a subsequent request to fetch the next batch of older products.

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.
ChargingMode
required
Charging mode of the product.
PostingMode
required
Posting mode of the product.
Options
required
Options of the product.
Promotions
required
Promotions of the service.
Classifications
required
Classifications of the service.
UnitAmount
required
Unit amount representing price of the product.

Product charging mode

  • Once
  • PerTimeUnit
  • PerPersonPerTimeUnit
  • PerPerson

Product posting mode

  • Once
  • PerTimeUnit

Product options

Property
Type
Contract
Description
BillAsPackage
boolean
required
Product should be displayed as part of a package.

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.