Get all products
POST /api/connector/v1/products/getAll
Returns all products offered together with the specified services. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the product.
Unique identifiers of the Services.
Interval in which the products were updated.
object
Whether or not to include default products for the service, i.e. products which are standard includes and not true extras. For example, the night’s stay would be the default product for a room reservation. These may be useful for accounting purposes but should not be displayed to customers for selection. If ProductIds are provided, IncludeDefault defaults to true, otherwise it defaults to false.
Example
{ "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 }}Responses
Section titled “ Responses ”OK
object
Products offered with the service.
object
Unique identifier of the product.
Unique identifier of the Service.
Unique identifier of the Product category.
Unique identifier of Accounting Category.
Whether the product is still active.
Name of the product. Deprecated! Please use Names
All translations of the name.
object
Name of the product meant to be displayed to customer. Deprecated! Please use ExternalNames
All translations of external name.
object
Short name of the product. Deprecated! Please use ShortNames
All translations of short name.
object
Description of the product. Deprecated! Please use Descriptions
All translations of descriptions.
object
Once
PerTimeUnit
PerPersonPerTimeUnit
PerPerson
Charging mode of the product.
Once
PerTimeUnit
PerPersonPerTimeUnit
PerPerson
Once
Daily
Charging mode of the product.
Once
PerTimeUnit
Options of the product.
object
Product should be displayed as part of a package.
Promotions of the product.
object
Whether it can be promoted before check-in.
Whether it can be promoted after check-in.
Whether it can be promoted during stay.
Whether it can be promoted before check-out.
Whether it can be promoted after check-out.
Whether it can be promoted during check-out.
Classifications of the product.
object
Product is classified as food.
Product is classified as beverage.
Product is classified as wellness.
Product is classified as city tax.
Product is classified as fee.
Price representing price of the product.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
Unique identifier of the product image.
Order value for presentation purposes.
Identifier of the product from external system.
Specifies the reason a product is exempt from tax.
IT_N1 (N1 - Escluse ex art.15)
IT_N2_2 (N2.2 - Non soggette – altri casi)
IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento)
IT_N4 (N4 - Esenti)
IT_N5 (N5 - Regime del margine / IVA non esposta in fattura)
PL_ZW (ZW - Zwolniony)
PL_NP (NP - Nie podlega)
Legal reference that states why this product is exempt from tax.
Creation date and time of the product in UTC timezone in ISO 8601 format.
Last update date and time of the product in UTC timezone in ISO 8601 format.
Consumption moment of the product.
ServiceOrderEnd
ServiceOrderStart
PostingTimeUnit
NextTimeUnit
Products offered specifically to customers.
object
Unique identifier of the product.
Unique identifier of the Service.
Unique identifier of the Product category.
Unique identifier of Accounting Category.
Whether the product is still active.
Name of the product. Deprecated! Please use Names
All translations of the name.
object
Name of the product meant to be displayed to customer. Deprecated! Please use ExternalNames
All translations of external name.
object
Short name of the product. Deprecated! Please use ShortNames
All translations of short name.
object
Description of the product. Deprecated! Please use Descriptions
All translations of descriptions.
object
Once
PerTimeUnit
PerPersonPerTimeUnit
PerPerson
Charging mode of the product.
Once
PerTimeUnit
PerPersonPerTimeUnit
PerPerson
Once
Daily
Charging mode of the product.
Once
PerTimeUnit
Options of the product.
object
Product should be displayed as part of a package.
Promotions of the product.
object
Whether it can be promoted before check-in.
Whether it can be promoted after check-in.
Whether it can be promoted during stay.
Whether it can be promoted before check-out.
Whether it can be promoted after check-out.
Whether it can be promoted during check-out.
Classifications of the product.
object
Product is classified as food.
Product is classified as beverage.
Product is classified as wellness.
Product is classified as city tax.
Product is classified as fee.
Price representing price of the product.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
Unique identifier of the product image.
Order value for presentation purposes.
Identifier of the product from external system.
Specifies the reason a product is exempt from tax.
IT_N1 (N1 - Escluse ex art.15)
IT_N2_2 (N2.2 - Non soggette – altri casi)
IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento)
IT_N4 (N4 - Esenti)
IT_N5 (N5 - Regime del margine / IVA non esposta in fattura)
PL_ZW (ZW - Zwolniony)
PL_NP (NP - Nie podlega)
Legal reference that states why this product is exempt from tax.
Creation date and time of the product in UTC timezone in ISO 8601 format.
Last update date and time of the product in UTC timezone in ISO 8601 format.
Consumption moment of the product.
ServiceOrderEnd
ServiceOrderStart
PostingTimeUnit
NextTimeUnit
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.
Example
{ "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"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.