Products

Get all products

Returns all products offered together with the specified services. Note this operation uses Pagination and supports Portfolio Access Tokens.

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"
    ],
    "UpdatedUtc": {
        "StartUtc": "2023-10-01T00:00:00Z",
        "EndUtc": "2023-10-31T00: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.
ServiceIds	array of string	required, max 1000 items	Unique identifiers of the Services.
UpdatedUtc	Time interval	optional, max length 3 months	Interval in which Product was updated.
Limitation	Limitation	required	Limitation on the quantity of products returned.

Response

{
    "Products": [
        {
            "Id": "198bc308-c1f2-4a1c-a827-c41d99d52f3d",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "CategoryId": null,
            "AccountingCategoryId": "6535e19e-1077-49d9-a338-67bf4ffecb14",
            "IsActive": true,
            "Names": {
                "en-US": "Breakfast"
            },
            "ExternalNames": {
                "en-US": "Breakfast"
            },
            "ShortNames": {
                "en-US": "BFST"
            },
            "Descriptions": {
                "en-US": "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
            },
            "Price": {
                "GrossValue": 25,
                "Currency": "EUR",
                "TaxValues": [
                    {
                        "Code": "FR-T"
                    }
                ]
            },
            "ExternalIdentifier": "PROD-BFST-009"
        }
    ],
    "CustomerProducts" : [
        {
            "Id": "198bc308-c1f2-4a1c-a827-c41d99d52f3d",
            "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "CategoryId": null,
            "AccountingCategoryId": "6535e19e-1077-49d9-a338-67bf4ffecb14",
            "IsActive": true,
            "Names": {
                "en-US": "Breakfast"
            },
            "ExternalNames": {
                "en-US": "Breakfast"
            },
            "ShortNames": {
                "en-US": "BFST"
            },
            "Descriptions": {
                "en-US": "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
            },
            "Price": {
                "GrossValue": 25,
                "Currency": "EUR",
                "TaxValues": [
                    {
                        "Code": "FR-T"
                    }
                ]
            },
            "ExternalIdentifier": "PROD-BFST-009"
        }
    ],
    "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.
CreatedUtc	string	required	Creation date and time of the product in UTC timezone in ISO 8601 format.
UpdatedUtc	string	required	Last update date and time of the product in UTC timezone in ISO 8601 format.
CategoryId	string	optional	Unique identifier of the Product category.
AccountingCategoryId	string	optional	Unique identifier of Accounting Category.
IsActive	boolean	required	Whether the product is still active.
Name	string	required	Name of the product. Deprecated! Please use Names
Names	Localized text	required	All translations of the product name.
ExternalName	string	required	Name of the product meant to be displayed to customer. Deprecated! Please use ExternalNames
ExternalNames	Localized text	required	All translations of the product name meant to be displayed to customer.
ShortName	string	required	Short name of the product. Deprecated! Please use ShortNames
ShortNames	Localized text	required	All translations of the product short name.
Description	string	optional	Description of the product. Deprecated! Please use Descriptions
Descriptions	Localized text	optional	All translations of the product description.
ChargingMode	string Product charging mode	required	Charging mode of the product.
PostingMode	string Product posting mode	required	Posting mode of the product.
Options	Product options	required	Options of the product.
Promotions	Promotions	required	Promotions of the service.
Classifications	Product classifications	required	Classifications of the service.
Price	Amount value	required	Price representing price of the product.
ExternalIdentifier	string	optional, max 255 characters	Identifier of the product from external system.

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.

Delete products

Deletes specified products. Note this operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/products/delete

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseId": "aff75fbb-5cce-4fae-8039-b07000d16650",
    "ProductIds": [
        "1f60b9de-c042-4841-bcab-b07000d2201f"
    ]
}

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.
EnterpriseId	string	optional	Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
ProductIds	array of string	required, max 1000 items	Unique identifiers of the Products to delete.

Response

{}