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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the Services. |
| optional, max length 3 months | Interval in which Product was updated. | |
| required | Limitation on the quantity of products returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Product | required | Products offered with the service. |
| array of Product | required | Products offered specifically to customers. |
| 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. |
Get product pricing
Restricted!This operation is currently in beta-test and as such it is subject to change.
Returns prices for a given product for a specified time interval. 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: 100 hours if hours, 100 days if days, or 24 months if months. For more information about time units, see Time units. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/products/getPricing
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| 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. |
| string | required | Name and version of the client application. |
| string | required | Unique identifier of the Product whose prices should be returned. |
| 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. See Time units. |
| 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. See Time units. The maximum size of time interval depends on the service's time unit: 100 hours if hours, 100 days if days, or 24 months if months. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Product. |
| array of string | required | Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. |
| array of Amount value | required | Base prices of the product for each time unit covered by the time interval. |
| array of Age category price | required | Age category prices. |
Age category price
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Age category. |
| array of Amount value | required | Prices of the product for the resource category in the covered dates. |
Product
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the product. |
| string | required | Unique identifier of the Service. |
| string | required | Creation date and time of the product in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the product in UTC timezone in ISO 8601 format. |
| string | optional | Unique identifier of the Product category. |
| string | optional | Unique identifier of Accounting Category. |
| boolean | required | Whether the product is still active. |
|
|
|
|
| required | All translations of the product name. | |
|
|
|
|
| required | All translations of the product name meant to be displayed to customer. | |
|
|
|
|
| required | All translations of the product short name. | |
|
|
|
|
| optional | All translations of the product description. | |
| string Product charging mode | required | Charging mode of the product. |
| string Product posting mode | required | Posting mode of the product. |
| required | Options of the product. | |
| required | Promotions of the service. | |
| required | Classifications of the service. | |
| required | Price representing price of the product. | |
| 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 |
---|---|---|---|
| boolean | required | Product should be displayed as part of a package. |
Product classifications
Property | Type | Contract | Description |
---|---|---|---|
| boolean | required | Product is classified as food. |
| boolean | required | Product is classified as beverage. |
| boolean | required | Product is classified as wellness. |
| 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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
| array of string | required, max 1000 items | Unique identifiers of the Products to delete. |
Response
Last updated