GET products/show
This method returns information related with a product. Single product is returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| product_identifier (mandatory) | Identifier | The identifier of the product that should be returned as a result. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|
id | String | The ID of the retrieved product |
code | String | The code of the retrieved product |
alternative_code | String | The alternative code of the retrieved product |
description | String | The description of the retrieved product |
| short_description | String | A short description of the retrieved product |
| long_description | String | A long description of the retrieved product |
| priority_level | Integer | The priority level of the product |
| non_stockable | Boolean | The flag shoes if the retrieved product is non-stockable |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| global_rate | Global Rate Object | The global rate of the retrieved product |
type
| Product Type Object | The type of the retrieved product |
brand | Product Brand Object | The brand of the retrieved product |
family | Product Family Object | The product family of the retrieved product |
log_information | Log Information Object | The Log Information related with the retrieved product |
bundle_restrictions | Bundle Restrictions Object | The bundle restrictions of the new product This parameter is applicable only if the product is classified as a flexible bundle |
price_plans_set | Set of Price Plans Object | The Price Plans containing the retrieved product |
validity_set | Set of Product Validity Object | The Product validity of the retrieved product (If is empty then the product is always valid) |
categories_set | Set of Product to Product Category Object | The Product Categories of the retrieved product |
components_set | Set of Product Components Object | The components of the retrieved product. This is applicable only if the product type composition method is set to fixed or flexible bundle
|
| usage_service_catalogs_set | Set of Usage Service Catalogs Object | The Usage Service Catalogs containing the retrieved product. Available only when the retrieved product is a usage service. |
| tax_rate_set | Set of Tax Rate Objects | The TAX Rate of the retrieved product |
vat_rate_set | Set of Vat Rate Objects | The VAT Rate of the retrieved product |
| metadata_set | Set of Metadata Attributes | The set of metadata attributes available for the retrieved product |
| allowed_metadata_set | Set of Metadata Attributes | The allowed set of metadata attributes whose values will be set on the installed items. Available only for traceable physical goods |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
product_brand object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product brand |
| name | String | The Name of the retrieved product brand |
| alternative_code | String | The Alternative Code of the retrieved product brand |
| description | String | The Description of the retrieved product brand |
product_family object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
tax_rate response data object
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved Tax rate |
| name | String | The Name of the retrieved Tax rate |
| alternative_code | String | The Alternative Code of the retrieved Tax rate |
| description | String | The Description of the retrieved Tax rate |
vat_rate response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved vat rate |
| name | String | The Name of the retrieved vat rate |
| alternative_code | String | The Alternative Code of the retrieved vat rate |
| description | String | The Description of the retrieved vat rate |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
price_plan object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved price plan |
| name | String | The Name of the retrieved price plan |
| code | String | The Code of the retrieved price plan |
| description | String | The Description of the retrieved price plan |
| type | String | The Type of the retrieved price plan which can be BASE or CONDITIONAL |
| effective_date | Date | The Effective Date of the retrieved price plan |
| expiration_date | Date | The Expiration Date of the retrieved price plan |
| currency | Currency Object | The Currency of the retrieved price plan |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
product_validity object data response
| Name | Type | Description |
|---|
| id | String | The ID of the product validity |
valid_from | Date | The date that the product should become valid |
| valid_to | Date | The date that the product should become invalid. This is optional as a product can be valid for ever, starting from a specific date |
product_to_product_category object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product to product category component |
| category | Product Category Object | The product category of the retrieved product to product category component |
Referred Objects Response Data
product_category response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product category |
| name | String | The Name of the retrieved product category |
| code | String | The code of the retrieved product category |
| description | String | The Description of the retrieved product category |
product_component object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product component |
| quantity | float | The quantity of the product component. Available only for fixed bundle products |
| is_mandatory | Boolean | Defines whether the product should be provided as mandatory for the bundle or not |
| min_quantity | float | The minimum required quantity of the product component. Available only for flexible bundle products |
| max_quantity | float | The minimum required quantity of the product component. Available only for flexible bundle products |
| product | Product Object | The product of the retrieved product component |
| product_type | Product Type Object | The product type of the retrieved product components. Available only for flexible bundle products |
| product_family | Product Family Object | The product family of the retrieved product components. Available only for flexible bundle products |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
product_family object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
product_bundle_restrictions object data response
| Name | Type | Description |
|---|
number_of_product_types_restriction | Number | Restricts the number of product types that products can be used from Applicable only for FLEXIBLE bundle products |
number_of_product_families_restriction | Number | Restricts the number of product families that products can be used from Applicable only for FLEXIBLE bundle products |
usage_service_catalog object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| effective_date | Date | The Effective Date of the retrieved usage service catalog |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog
|
upsells object data response
Name | Type | Description |
|---|
upsell_product | String | The product which is considered as an upsell to the existing product |
| upsell_priority | Integer | The priority which can be used by the 3rd party system to decide the order by which the product will be displayed in relation to other upsell products |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
cross_sells object data response
Name | Type | Description |
|---|
cross_sell_product | String | The product which is considered as a cross-sell to the existing product. This is bidirectional, meaning that if Product A is defined as a cross-sell to Product B, then product B will be available as a cross-sell of product A |
| cross_sell_priority | Integer | The priority which can be used by the 3rd party system to decide the order by which the product will be displayed in relation to other cross-sell products |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
metadata attribute value response object
Name | Type | Description |
|---|
id | String | The ID of the retrieved metadata field, related to the entity for which it is retrieved |
| key | String | The key of the retrieved metadata field, related to the entity for which it is retrieved |
| name | String | The name of the retrieved metadata field, related to the entity for which it is retrieved |
| description | String | The description of the retrieved metadata field, related to the entity for which it is retrieved |
| type | String | The type of the retrieved metadata field, related to the entity for which it is retrieved. Available values are: - STRING
- INTEGER
- FLOAT
- BOOLEAN
- DATE
|
| value | String | The value of the specific metadata field, related to the entity for which it is retrieved |
allowed metadata attribute response object
Name | Type | Description |
|---|
id | String | The ID of the retrieved metadata attribute |
| key | String | The key of the retrieved metadata attribute |
| name | String | The name of the retrieved metadata attribute |
| description | String | The description of the metadata attribute |
| type | String | The type of the retrieved metadata. Available values are: - STRING
- INTEGER
- FLOAT
- BOOLEAN
- DATE
|
| is_mandatory | Boolean | Defines whether the metadata attribute is mandatory or not |
| values_set | Value set Object | The values available to be set for this metadata attribute. (Configurable) |
| default_value | depends on the type | The default value which is applicable if a value set is defined. |
Examples
Example 1
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_float_1": null,
"udf_float_2": null,
"brand":
{
"name": "Philips",
"id": "0CCF5FFE863F3753E49AD78C36FA23B3",
"description": "Band Philips",
"alternative_code": "Philips"
},
"udf_float_3": null,
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"validity_set":
[
],
"price_plans_set":
[
],
"id": "599C2CE3A1E25F69A8E2A367474E4336",
"family":
{
"name": "TV Premium",
"id": "432212996A7C11149A4B1F1D332096E5",
"description": "TV for Premium Customers",
"alternative_code": "TV PP"
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"code": "PRTV0000459",
"log_information":
{
"updated_date": "2014-07-15T15:22:55",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-15T15:20:05",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "JackH",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
},
"updated_by_user":
{
"person_name": "JackH",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
}
},
"vat_rate":
{
"name": "Standard 10%",
"id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
"description": null,
"alternative_code": "S10"
},
"components_set":
[
{
"set_component":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
},
"max_quantity": "F77E7AFCC1D7CE2C372330528A43F25E",
"min_quantity": "F77E7AFCC1D7CE2C372330528A43F25E",
"quantity": 1,
"id": "F77E7AFCC1D7CE2C372330528A43F25E"
},
{
"set_component":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FIXEDBUNDLE",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "3FACF409E7E091F96C52318BAD1AEF1C",
"description": "Local + Documentaries + Sport",
"code": "Local + Documentaries + Sport",
"alternative_code": null
},
"max_quantity": "123A393351452B6A71FF667CAE563F5D",
"min_quantity": "123A393351452B6A71FF667CAE563F5D",
"quantity": 1,
"id": "123A393351452B6A71FF667CAE563F5D"
}
],
"type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FIXEDBUNDLE",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"description": null,
"categories_set":
[
],
"alternative_code": "PRTV459"
}
}
GET products/list
This method returns information related with products. Multiple products are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| product_identifier (semi-optional) | Identifier | The identifier of the product that should be returned as a result. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
| type_identifier (semi-optional) | Identifier | The identifier of the product type related with the products that will be returned as results. The allowed product type identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product type | name (semi-optional) | String | The name of the product type | alternative_code (semi-optional) | String | The alternative code of a product type |
|
| brand_identifier (semi-optional) | Identifier | The identifier of the product brand related with the products that will be returned as results. The allowed product brand identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product brand | name (semi-optional) | String | The name of the product brand | alternative_code (semi-optional) | String | The alternative code of a product brand |
|
| family_identifier (semi-optional) | Identifier | The identifier of the product family related with the products that will be returned as results. The allowed product family identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product family | name (semi-optional) | String | The name of the product family | code (semi-optional) | String | The code of a product family |
|
| category_identifier (semi-optional) | Identifier | The identifier of the product category related with the products that will be returned as results. The allowed product category identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product category | name (semi-optional) | String | The name of the product category | code (semi-optional) | String | The code of a product category |
|
as_of_date_valid (optional) | Date | Returns only the products that are valid based on specific date |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|
id | String | The ID of the retrieved product |
code | String | The code of the retrieved product |
alternative_code | String | The alternative code of the retrieved product |
description | String | The description of the retrieved product |
| short_description | String | A short description of the retrieved product |
| long_description | String | A long description of the retrieved product |
| priority_level | Integer | The priority level of the product |
| non_stockable | Boolean | The flag shoes if the retrieved product is non-stockable |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| global_rate | Global Rate Object | The global rate of the retrieved product |
type
| Product Type Object | The type of the retrieved product |
brand | Product Brand Object | The brand of the retrieved product |
family | Product Family Object | The product family of the retrieved product |
log_information | Log Information Object | The Log Information related with the retrieved product |
bundle_restrictions | Bundle Restrictions Object | The bundle restrictions of the new product This parameter is applicable only if the product is classified as a flexible bundle |
price_plans_set | Set of Price Plans Object | The Price Plans containing the retrieved product |
validity_set | Set of Product Validity Object | The Product validity of the retrieved product (If is empty then the product is always valid) |
categories_set | Set of Product to Product Category Object | The Product Categories of the retrieved product |
components_set | Set of Product Components Object | The components of the retrieved product. This is applicable only if the product type composition method is set to fixed or flexible bundle
|
| usage_service_catalogs_set | Set of Usage Service Catalogs Object | The Usage Service Catalogs containing the retrieved product. Available only when the retrieved product is a usage service. |
| tax_rate_set | Set of Tax Rate Objects | The TAX Rate of the retrieved product |
vat_rate_set | Set of Vat Rate Objects | The VAT Rate of the retrieved product |
| metadata_set | Set of Metadata Attributes | The set of metadata attributes available for the retrieved product |
| allowed_metadata_set | Set of Metadata Attributes | The allowed set of metadata attributes whose values will be set on the installed items. Available only for traceable physical goods |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
product_brand object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product brand |
| name | String | The Name of the retrieved product brand |
| alternative_code | String | The Alternative Code of the retrieved product brand |
| description | String | The Description of the retrieved product brand |
product_family object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
tax_rate response data object
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved Tax rate |
| name | String | The Name of the retrieved Tax rate |
| alternative_code | String | The Alternative Code of the retrieved Tax rate |
| description | String | The Description of the retrieved Tax rate |
vat_rate response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved vat rate |
| name | String | The Name of the retrieved vat rate |
| alternative_code | String | The Alternative Code of the retrieved vat rate |
| description | String | The Description of the retrieved vat rate |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
price_plan object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved price plan |
| name | String | The Name of the retrieved price plan |
| code | String | The Code of the retrieved price plan |
| description | String | The Description of the retrieved price plan |
| type | String | The Type of the retrieved price plan which can be BASE or CONDITIONAL |
| effective_date | Date | The Effective Date of the retrieved price plan |
| expiration_date | Date | The Expiration Date of the retrieved price plan |
| currency | Currency Object | The Currency of the retrieved price plan |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
product_validity object data response
| Name | Type | Description |
|---|
| id | String | The ID of the product validity |
valid_from | Date | The date that the product should become valid |
| valid_to | Date | The date that the product should become invalid. This is optional as a product can be valid for ever, starting from a specific date |
product_to_product_category object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product to product category component |
| category | Product Category Object | The product category of the retrieved product to product category component |
Referred Objects Response Data
product_category response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product category |
| name | String | The Name of the retrieved product category |
| code | String | The code of the retrieved product category |
| description | String | The Description of the retrieved product category |
product_component object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product component |
| quantity | float | The quantity of the product component. Available only for fixed bundle products |
| is_mandatory | Boolean | Defines whether the product should be provided as mandatory for the bundle or not |
| min_quantity | float | The minimum required quantity of the product component. Available only for flexible bundle products |
| max_quantity | float | The minimum required quantity of the product component. Available only for flexible bundle products |
| product | Product Object | The product of the retrieved product component |
| product_type | Product Type Object | The product type of the retrieved product components. Available only for flexible bundle products |
| product_family | Product Family Object | The product family of the retrieved product components. Available only for flexible bundle products |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
product_family object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
product_bundle_restrictions object data response
| Name | Type | Description |
|---|
number_of_product_types_restriction | Number | Restricts the number of product types that products can be used from Applicable only for FLEXIBLE bundle products |
number_of_product_families_restriction | Number | Restricts the number of product families that products can be used from Applicable only for FLEXIBLE bundle products |
usage_service_catalog object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| effective_date | Date | The Effective Date of the retrieved usage service catalog |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog
|
upsells object data response
Name | Type | Description |
|---|
upsell_product | String | The product which is considered as an upsell to the existing product |
| upsell_priority | Integer | The priority which can be used by the 3rd party system to decide the order by which the product will be displayed in relation to other upsell products |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
cross_sells object data response
Name | Type | Description |
|---|
cross_sell_product | String | The product which is considered as a cross-sell to the existing product. This is bidirectional, meaning that if Product A is defined as a cross-sell to Product B, then product B will be available as a cross-sell of product A |
| cross_sell_priority | Integer | The priority which can be used by the 3rd party system to decide the order by which the product will be displayed in relation to other cross-sell products |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
metadata attribute value response object
Name | Type | Description |
|---|
id | String | The ID of the retrieved metadata field, related to the entity for which it is retrieved |
| key | String | The key of the retrieved metadata field, related to the entity for which it is retrieved |
| name | String | The name of the retrieved metadata field, related to the entity for which it is retrieved |
| description | String | The description of the retrieved metadata field, related to the entity for which it is retrieved |
| type | String | The type of the retrieved metadata field, related to the entity for which it is retrieved. Available values are: - STRING
- INTEGER
- FLOAT
- BOOLEAN
- DATE
|
| value | String | The value of the specific metadata field, related to the entity for which it is retrieved |
allowed metadata attribute response object
Name | Type | Description |
|---|
id | String | The ID of the retrieved metadata attribute |
| key | String | The key of the retrieved metadata attribute |
| name | String | The name of the retrieved metadata attribute |
| description | String | The description of the metadata attribute |
| type | String | The type of the retrieved metadata. Available values are: - STRING
- INTEGER
- FLOAT
- BOOLEAN
- DATE
|
| is_mandatory | Boolean | Defines whether the metadata attribute is mandatory or not |
| values_set | Value set Object | The values available to be set for this metadata attribute. (Configurable) |
| default_value | depends on the type | The default value which is applicable if a value set is defined. |
Examples
Example 1
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"family":
{
"name": "LED TV",
"id": "23B1B61652524515C440DF0CDC02E12B",
"description": null,
"alternative_code": "LET"
},
"brand":
{
"name": "Samsung",
"id": "E262BDC87F97B8DA8762D1507CCBF3C7",
"description": null,
"alternative_code": "SAM"
},
"id": "599C2CE3A1E25F69A8E2A367474E4336",
"code": "SSTV0000452"
},
{
"family":
{
"name": "LED TV",
"id": "23B1B61652524515C440DF0CDC02E12B",
"description": null,
"alternative_code": "LET"
},
"brand":
{
"name": "Samsung",
"id": "E262BDC87F97B8DA8762D1507CCBF3C7",
"description": null,
"alternative_code": "SAM"
},
"id": "58DB60D0C959E2154B14CFA6EB90F88D",
"code": "SSTV0000453"
}
]
}
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_string_10": null,
"udf_string_11": null,
"udf_float_1": null,
"brand": null,
"udf_string_12": null,
"udf_float_2": null,
"udf_string_13": null,
"udf_float_3": null,
"udf_string_14": null,
"udf_float_4": null,
"udf_string_15": null,
"udf_string_1": null,
"udf_string_16": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null,
"validity_set":
[
],
"price_plans_set":
[
{
"effective_date": "2014-06-25T00:00:00",
"type": "BASE",
"name": "Main Price Plan2014",
"id": "361A5B0377E4D98A089314C1281A5C47",
"description": "Main Price PLan for 2014",
"code": "MPP14",
"expiration_date": null,
"version_num": 0
},
{
"effective_date": "2014-07-15T00:00:00",
"type": "BASE",
"name": "BPPO614",
"id": "538C3F3B580F27E96C7E7A991D85158E",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": "2014-08-01T00:00:00",
"version_num": 1
},
{
"effective_date": "2014-06-26T13:28:51",
"type": "CONDITIONAL",
"name": "Conditional Concurrent BPP",
"id": "3AA88864A741065067630E7FBAC2F803",
"description": "Conditional Concurrent BPP",
"code": "CCBPP",
"expiration_date": null,
"version_num": 0
},
{
"effective_date": "2014-06-26T00:00:00",
"type": "BASE",
"name": "Concurrent BPP",
"id": "D6588D195B7C3994ECCC662B93CD7948",
"description": "Concurrent BPP",
"code": "CBPP",
"expiration_date": null,
"version_num": 0
},
{
"effective_date": "2014-06-26T12:28:17",
"type": "CONDITIONAL",
"name": "CPPO614",
"id": "CD976B50D87159B6B719DBE567447B27",
"description": "Conditional Price PLan June 14 for Subscription Test Case 6",
"code": "CPPO614",
"expiration_date": null,
"version_num": 0
},
{
"effective_date": "2014-08-01T00:00:00",
"type": "BASE",
"name": "BPPO614",
"id": "FAAAC298881EA8FDC45E24F405B64D5C",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": null,
"version_num": 3
},
{
"effective_date": "2014-06-26T14:51:28",
"type": "CONDITIONAL",
"name": "Cond Discount 2",
"id": "9F7E007DF69EDE81FA9B8D243E51430D",
"description": "Conditional Discounted 2 Base Price PLan June 14 for Subscription Test Case 6",
"code": "DSC2",
"expiration_date": null,
"version_num": 0
},
{
"effective_date": "2014-06-26T00:00:00",
"type": "BASE",
"name": "BPPO614",
"id": "37BA355DDD0D5E287CEE7C7A8465748C",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": "2014-07-15T00:00:00",
"version_num": 0
},
{
"effective_date": "2014-06-26T14:34:00",
"type": "CONDITIONAL",
"name": "Cond Discounted 1",
"id": "4F15B897B82B11E0242BDCBFA5DDF42E",
"description": "Conditional Discounted 1 Base Price PLan June 14 for Subscription Test Case 6 ",
"code": "DSC1",
"expiration_date": null,
"version_num": 0
},
{
"effective_date": "2014-08-01T00:00:00",
"type": "BASE",
"name": "BPPO614",
"id": "97C491CC697E4F5B0F89BB545DE5B6B7",
"description": "Base Price PLan June 14 for Subscription Test Case 6",
"code": "BPP0614",
"expiration_date": "2014-08-01T00:00:00",
"version_num": 2
}
],
"id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
"family": null,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"code": "Gold",
"log_information":
{
"updated_date": "2014-06-26T17:34:31",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-05-16T10:10:37",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"vat_rate":
{
"name": "Standard 10%",
"id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
"description": null,
"alternative_code": "S10"
},
"components_set":
[
{
"set_component":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription services",
"id": "600438B64B0F05AB3D020C902674949F",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "4D55A6EC2FF25A44B9945B88940AF1A0",
"description": "Sports 2 Packages",
"code": "Sports 2",
"alternative_code": "S2"
},
"max_quantity": "4206E0D6D6B95F1568A1923E794C700B",
"min_quantity": "4206E0D6D6B95F1568A1923E794C700B",
"quantity": null,
"id": "4206E0D6D6B95F1568A1923E794C700B"
},
{
"set_component":
{
"product_type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription services",
"id": "600438B64B0F05AB3D020C902674949F",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "EBAC84F9A0086191BD58B624D236D61D",
"description": "Sports 1 Package",
"code": "Sports 1",
"alternative_code": "S1"
},
"max_quantity": "0F8566FAF74103C57DE196DB54F9BD1B",
"min_quantity": "0F8566FAF74103C57DE196DB54F9BD1B",
"quantity": null,
"id": "0F8566FAF74103C57DE196DB54F9BD1B"
}
],
"type":
{
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FIXEDBUNDLE",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"description": "Gold Premium Package",
"categories_set":
[
{
"id": "6547020273FD3A7E9B52F7258FE7A341",
"category":
{
"name": "Residential 2",
"id": "12BE7A9BC9CE6A189C268F6440A60AB2",
"description": "Residential 2",
"alternative_code": null
}
}
],
"alternative_code": "GPP"
}
}