Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

This method returns information related with a product.  Single product is returned by each call

...

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:

Include Page
V4:product_identifier
V4:product_identifier

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

...

Expand
titleExample 2

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
      {
    "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"
    }
}
Expand
titleExample 3

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": {
        "code": "Otenet FL Bouquet",
        "alternative_code": "OFLB",
        "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": "2016-02-08T18:00:02",
            "updated_date": "2017-08-21T11:39:55",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "Persy Xenopoulou",
                "id": "6D7E8CA9F3254F23A5511E20C1D92DB8",
                "email": "p_xenopoulou@crm.com",
                "username": "p_xenopoulou"
            }
        },
        "components_set": [
            {
                "product": {
                    "code": "Bronze",
                    "product_type": {
                        "service_type": "TERMED",
                        "used_for_provisioning": true,
                        "alternative_code": "Main Packages",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Main Packages",
                        "description": null,
                        "id": "E186E293AAAB49EE86A729540A4287FE",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "B",
                    "description": "Bronze",
                    "id": "F50CC52934BD4F119B6E18E215A4FC55"
                },
                "quantity": 1,
                "max_quantity": null,
                "min_quantity": 1,
                "id": "6E61C98250FE47E7A89DD7ECC31E5BF9"
            },
            {
                "product_type": {
                    "service_type": "TERMED",
                    "used_for_provisioning": true,
                    "alternative_code": "AS",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "Additional Services",
                    "description": null,
                    "id": "C8321F0BCA8A4051857BC35CEEE41555",
                    "classification": "SERVICES",
                    "physical_good_type": null
                },
                "quantity": 1,
                "max_quantity": 3,
                "min_quantity": 0,
                "id": "E11FCBFD8D294DC59D5EF6059CCA6BB2"
            }
        ],
        "price_plans_set": [
            {
                "code": "Test FW changes",
                "name": "Test FW changes",
                "effective_date": "2016-12-06T00:00:00",
                "description": null,
                "id": "0F91BBAA241B41EFBBF4FCB270AF94F4",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "PK Main",
                "name": "PK Main",
                "effective_date": "2017-02-06T00:00:00",
                "description": "Main Price Plan",
                "id": "9B9690AFD6914EBBB4BEB7A00AA76567",
                "type": "CONDITIONAL",
                "expiration_date": null
            },
            {
                "code": "MPP",
                "name": "Main Price Plan",
                "effective_date": "2017-05-31T00:00:00",
                "description": "Main Price Plan",
                "id": "D48ADE1316F44DA6BBCDA7C4E654980A",
                "type": "BASE",
                "expiration_date": null
            }
        ],
        "description": "Get the Bronze Package and add up to 3 additional services",
        "udf_date_2": null,
        "type": {
            "service_type": "TERMED",
            "used_for_provisioning": false,
            "alternative_code": "FSB",
            "udr_type": null,
            "composition_method": "FLEXIBLEBUNDLE",
            "name": "Flexible Service Bundles",
            "description": "Flexible Service Bundles",
            "id": "F78EC7EA238542AF9C51A5550A1A969A",
            "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,
        "bundle_restrictions": [
            {
                "number_of_product_families_restriction": 3,
                "number_of_product_types_restriction": 5
            }
        ],
        "id": "B00022BEB678417686FC9D8B7BD06192",
        "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": [],
        "tax_rate_set": [
            {
                "alternative_code": "ST",
                "name": "Sales Tax",
                "description": null,
                "id": "E85BD1C608E64EB8820C2087982B303A"
            },
            {
                "alternative_code": "TT",
                "name": "Telephony Tax",
                "description": null,
                "id": "DA6DD47A53DC4CBB8D0EEF698B08E94A"
            }
        ],
        "vat_rate_set": [
            {
                "alternative_code": "NV",
                "name": "No VAT",
                "description": null,
                "id": "D0AE6EF863A04295A7BDF6E2FEFEE9FC"
            },
            {
                "alternative_code": "VAT 9%",
                "name": "VAT 9%",
                "description": null,
                "id": "48ADFA77916048328685049A3B7E3F64"
            }
        ],
        "udf_string_9": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}