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:
| ||||||||||||
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 Available from CRM.COM R16.3.0 and onwards |
| long_description | String | A long description of the retrieved product Available from CRM.COM R12.3.0 and CRM.COM R13.1.0 onwards |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| non_stockable | Boolean | The flag shoes if the retrieved product is non-stockable Available from CRM.COM R18.0.0 |
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 Available from CRM.COM R15.0.0 |
Product Type Object | The type of the retrieved product | |
Product Brand Object | The brand of the retrieved product | |
Product Family Object | The product family of the retrieved product | |
Log Information Object | The Log Information related with the retrieved product | |
| Bundle Restrictions Object | The bundle restrictions of the new product This parameter is applicable only if the product is classified as a flexible bundle Available from CRM.COM R14.0.0 | |
Set of Price Plans Object | The Price Plans containing the retrieved product | |
Set of Product Validity Object | The Product validity of the retrieved product (If is empty then the product is always valid) | |
Set of Product to Product Category Object | The Product Categories of the retrieved product | |
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. Available from CRM.COM R9.0.0 |
| tax_rate_set | Set of Tax Rate Objects | The TAX Rate of the retrieved product Available from CRM.COM R14.0.0 |
Set of Vat Rate Objects | The VAT Rate of the retrieved product Deprecate from CRM.COM R17.0.0 | |
| metadata_set | Set of Metadata Attributes | The set of metadata attributes available for the retrieved product Available from CRM.COM R15.0.0 |
| 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 Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": {
"code": "V for Vendetta",
"alternative_code": "VFV",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-03-10T13:13:57",
"updated_date": "2017-03-10T13:17:33",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"components_set": [],
"price_plans_set": [],
"description": "V for Vendetta VOD",
"udf_date_2": null,
"type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "VS",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "VOD Service",
"description": null,
"id": "B06ACBEF10A24057902837A51BCB2B36",
"classification": "SERVICES",
"physical_good_type": null
},
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_15": null,
"categories_set": [],
"udf_string_16": null,
"udf_string_13": null,
"validity_set": [],
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "FD50BBBFAC7245838F205F5C143F54AE",
"udf_string_10": null,
"udf_float_1": null,
"udf_float_2": null,
"brand": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"udf_string_6": null,
"family": null,
"udf_string_7": null,
"udf_string_8": null,
"usage_service_catalogs_set": [
{
"alternative_code": "T_1",
"name": "Test MA",
"description": null,
"id": "6266FE95E731484E82263A9A69331095"
},
{
"alternative_code": "NPTM",
"name": "No Provider Test MA",
"description": null,
"id": "B71A453D29474A0B96A37F82D8B0B329"
},
{
"alternative_code": "UTM",
"name": "USC Test MA",
"description": null,
"id": "EE4119049F7F4D8A90E381A68B35B00A"
}
],
"udf_string_9": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"usage_service_catalogs_set":
[
],
"udf_string_10": null,
"udf_string_11": null,
"udf_float_1": null,
"brand":
{
"name": "Samsung",
"id": "E262BDC87F97B8DA8762D1507CCBF3C7",
"description": null,
"alternative_code": "SAM"
},
"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":
[
],
"id": "A2B00E27070BEB1B1273733260A45ACC",
"family":
{
"name": "Movie Packages 3",
"id": "226492B49E346D0C3236EC740E7509F4",
"description": "Pay-TV",
"code": null
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"code": "Athina STB",
"log_information":
{
"updated_date": "2014-11-12T14:09:08",
"created_date": "2012-06-29T14:04:36",
"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": "Low",
"id": "D7325EE39EEB46EF0BE628239F88C882",
"description": null,
"alternative_code": "LOW"
},
"components_set":
[
],
"type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"description": "Athina STB",
"categories_set":
[
{
"id": "37D7C2B9C1012296BB1763ACADEA8807",
"category":
{
"name": "Residential 2",
"id": "12BE7A9BC9CE6A189C268F6440A60AB2",
"description": "Residential 2",
"code": "22"
}
}
],
"alternative_code": "A-STB"
}
}