Table of Contents

maxLevel	2

...

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

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "taxudf_float_code1": null,
       {
   "udf_float_2": null,
         "defaultbrand":
false,        {
    "effective_date": null,             "percentage"name": 10"Philips",
            "id": "1D3F3BA24EEBBD50E4B3289F0CB508850CCF5FFE863F3753E49AD78C36FA23B3",
            "description": "10Band Philips",
            "alternative_code": null"Philips"
        },
        "udf_float_13": null,
        "udf_float_24": null,
        "brandudf_string_1": null,
       {
   "udf_string_2": null,
         "nameudf_string_3": "Test1",
   null,
        "idudf_string_4": "0CCF5FFE863F3753E49AD78C36FA23B3",
   null,
        "alternativeudf_string_code5": "Test"
        }null,
        "udf_floatstring_36": null,
        "udf_floatstring_47": null,
        "udf_string_18": null,
        "udfvalidity_string_2set":
null,         "udf_string_3": null,[
         "udf_string_4": null],
        "udfprice_stringplans_5set": null,
        "udf_string_6": null,[
        "udf_string_7": null],
        "udf_string_8id": null"599C2CE3A1E25F69A8E2A367474E4336",
        "validity_setfamily":
        [{
            {
  "name": "TV Premium",
             "id": "75F0A51A812B89014958AFD2BA476A6B432212996A7C11149A4B1F1D332096E5",
  
             "valid_fromdescription": "2014-03-01T00:00:00",
   TV for Premium Customers",
            "validalternative_tocode": "2014-04-30T00:00:00TV PP"
        },
   }         ]"udf_date_1": null,
        "priceudf_plansdate_set2": null,
       [
  "udf_date_3": null,
      ],  "udf_date_4": null,
        "idcode": "367A10D0A25DE1CCFAB298903DC082AEPRTV0000459",
        "familylog_information":
        {
            "nameupdated_date": "Movie Packages 32014-07-15T15:22:55",
            "idcreated_by_unit": "226492B49E346D0C3236EC740E7509F4",
            "alternative_code": "1"
{
       },         "udfcommunity_date_1name": "Main nullCommunity",

       "udf_date_2": null,         "udfgroup_date_3name": "Main null,Group",
            "udf_date_4    "name": "Admin null,Unit",
                "codeid": "test product48305F8849E3C18B227C5BE3A27BA6DF",
            "log_information":    "description": "r1",
   {             "updatedalternative_datecode": "2014-03-27T10:43:49"MG"
            },
            "created_date": "20132014-07-23T1615T15:0120:3905",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": null"MG"
            },
            "created_by_user":
            {
                "person_name": "Master PartnerJackH",
                "username": "MPAdministratorJackH",
                "id": "1B8650C555C4EA8C741103961276E7773",
                "email": "j_hadjicosti@crm.com"
            },
            "updated_by_user":
            {
                "person_name": "Master PartnerJackH",
                "username": "MPAdministratorJackH",
                "id": "1B8650C555C4EA8C741103961276E7773",
            }    "email": "j_hadjicosti@crm.com"
   },         "components_set":}
        [
        ]},
        "typevat_rate":
        {
            "name": "testStandard 10%",
            "id": "12D79B1697759744C21D68F3D9617EECF170FB2FF32E8C4F5A569E8F3B461E1F",
            "alternative_codedescription": "tests"
null,
       },     "alternative_code": "S10"
      "description": "test product"},
        "categoriescomponents_set":
        [
            {
                "idset_component": "AA950BF4170835FD9FAED95CC678DA43",
                {
     "category":               "product_type":
 {                   {
 "name": "Residential 1",                     "idphysical_good_type": "AB7967530FB60ECC0C645B63739D6073",null,
                        "alternativeservice_codetype": "USAGE",
null                 }       "used_for_provisioning": true,
    }         ],           "alternative_codecomposition_method": "FLAT",
                        "classification": "tp"SERVICES",
             } }

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

...

(semi-optional)

...

The identifier of the product that should be returned as a result. The allowed product identifier fields are the following:

...

(semi-optional)

...

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:

...

(semi-optional)

...

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:

...

(semi-optional)

...

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:

...

(semi-optional)

...

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:

...

as_of_date_valid

(optional)

...

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

...

Examples

Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null, "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":
                {
            "description": null,
        "codeproduct_type": "OK"
             },     "data":  {
  [         {             "taxphysical_good_codetype":     null,
       {                 "defaultservice_type": false"TERMED",
                "effective_date": null,          "used_for_provisioning": true,
      "percentage": 10,                 "idcomposition_method": "1D3F3BA24EEBBD50E4B3289F0CB50885FIXEDBUNDLE",
                        "descriptionclassification": "10SERVICES",
                 "alternative_code       "name": null"Subscription Packages",
           },             "udf_float_1id": null"BC954969D3172372D498D3BB2BA590A0",
 
          "udf_float_2": null,             "branddescription": "Subscription main   packages",
       {                 "namealternative_code": "Test1SP",
                   "id": "0CCF5FFE863F3753E49AD78C36FA23B3", },
                    "alternative_codeid": "Test3FACF409E7E091F96C52318BAD1AEF1C",
            },        "description": "Local + Documentaries + "udf_float_3": null,Sport",
                    "udf_float_4code": null,"Local + Documentaries +  Sport",
       "udf_string_1": null,             "udfalternative_string_2code": null,
               "udf_string_3": null, },
                "udfmax_string_4quantity": null,"123A393351452B6A71FF667CAE563F5D",
                "udfmin_string_5quantity": null,"123A393351452B6A71FF667CAE563F5D",
                "udf_string_6quantity": null1,
                "udf_string_7id": null, "123A393351452B6A71FF667CAE563F5D"
            }
   "udf_string_8": null,    ],
        "validity_settype":
        {
   [             ]"physical_good_type": null,
            "priceservice_plans_settype": "TERMED",
            "used_for_provisioning": true,
[             ]"composition_method": "FIXEDBUNDLE",
            "idclassification": "367A10D0A25DE1CCFAB298903DC082AESERVICES",
            "familyname":             {
   "Subscription Packages",
            "nameid": "Movie Packages 3BC954969D3172372D498D3BB2BA590A0",
   
            "iddescription": "226492B49E346D0C3236EC740E7509F4Subscription main packages",
   
            "alternative_code": "1SP"
        },
     },   "description": null,
        "udfcategories_date_1set":
null,         [
   "udf_date_2": null,    ],
        "udfalternative_date_3code": null,"PRTV459"
    }
}    
  "udf_date_4": null,
            "code": "test product",
            "log_information":
            {
                "updated_date": "2014-03-27T10:48:04",
                "created_date": "2013-07-23T16:01:39",
                "updated_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": null
                },
                "created_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "components_set":
            [
            ],
            "type":
            {
                "name": "test",
                "id": "12D79B1697759744C21D68F3D9617EEC",
                "alternative_code": "tests"
            },
            "description": "test product",
            "categories_set":
            [
                {
                    "id": "AA950BF4170835FD9FAED95CC678DA43",
                    "category":
                    {
                        "name": "Residential 1",
                        "id": "AB7967530FB60ECC0C645B63739D6073",
                        "alternative_code": null
                    }
                }
            ],
            "alternative_code": "tp"
        },
        {
            "tax_code":
            {
                "default": true,
                "effective_date": null,
                "percentage": 20,
                "id": "18",
                "description": "V.A.T. 20%",
                "alternative_code": "2000"
            },
            "udf_float_1": null,
            "udf_float_2": null,
            "brand":
            {
                "name": "Test1",
                "id": "0CCF5FFE863F3753E49AD78C36FA23B3",
                "alternative_code": "Test"
            },
            "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": "DAD03F53603E48B419E48BFDD737B65C",
            "family":
            {
                "name": "Movie Packages2 ",
                "id": "6902FB8B7A0BCC2AC52631B9DCC99DBE",
                "alternative_code": "3"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "Add on for P1",
            "log_information":
            {
                "updated_date": "2014-03-26T17:12:35",
                "created_date": "2012-05-08T15:20:46",
                "updated_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": null
                },
                "created_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "components_set":
            [
            ],
            "type":
            {
                "name": "Subscription",
                "id": "2B0EC029035C637200648C9B2D6A2FFB",
                "alternative_code": "SUBSCRIPTION"
            },
            "description": "Add on for P1",
            "categories_set":
            [
                {
                    "id": "740DB5164CC87E5D17100845967CA510",
                    "category":
                    {
                        "name": "Residential 1",
                        "id": "AB7967530FB60ECC0C645B63739D6073",
                        "alternative_code": null
                    }
                },
                {
                    "id": "C26961C7C48D83F1860573C3832D1CCE",
                    "category":
                    {
                        "name": "Residential 2",
                        "id": "12BE7A9BC9CE6A189C268F6440A60AB2",
                        "alternative_code": null
                    }
                }
            ],
            "alternative_code": "P1"
        },
        {
            "tax_code":
            {
                "default": true,
                "effective_date": null,
                "percentage": 20,
                "id": "18",
                "description": "V.A.T. 20%",
                "alternative_code": "2000"
            },
            "udf_float_1": null,
            "udf_float_2": null,
            "brand":
            {
                "name": "Test1",
                "id": "0CCF5FFE863F3753E49AD78C36FA23B3",
                "alternative_code": "Test"
            },
            "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":
            [
                {
                    "id": "5E3EC1DA286670CA778EA866C63EA815",
                    "valid_from": "2012-06-01T01:55:41",
                    "valid_to": null
                }
            ],
            "price_plans_set":
            [
            ],
            "id": "DBC04604FA8626E5E380AC5C59A28017",
            "family":
            {
                "name": "Movie Packages 1",
                "id": "97BF1778AB08D1CCE8E0A3DE1590AECC",
                "alternative_code": "2"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "Desc",
            "log_information":
            {
                "updated_date": "2013-07-22T22:47:01",
                "created_date": "2012-06-02T01:50:08",
                "updated_by_unit":
                {
                    "group_name": null,
                    "name": "Verification Unit",
                    "id": "F80C8030B13BB3CEDBD6D31F198F98D0",
                    "description": null,
                    "alternative_code": "Verification"
                },
                "created_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "Rossides Giorkos",
                    "username": "g_rossides",
                    "id": "4AD9C84FA60F9FE407140E20F707726A"
                }
            },
            "components_set":
            [
                {
                    "set_component":
                    {
                        "number": null,
                        "id": "293DD7C2E2C7425B13937BBC737254F7",
                        "description": "HUMAX Digital Satellite Receiver/Decoder IR-6000Z",
                        "alternative_code": null
                    },
                    "quantity": 1,
                    "id": "22816CE8E2FDDA721D8CB75BB6B55DF8"
                },
                {
                    "set_component":
                    {
                        "number": null,
                        "id": "E643A06D8F0E8AF5B11ECB909B57C809",
                        "description": "HUMAX Digital Satellite Receiver/Decoder IR-5000Z",
                        "alternative_code": null
                    },
                    "quantity": 1,
                    "id": "E9B9BBD72FCCF72BD94ECBEEF076EB37"
                }
            ],
            "type":
            {
                "name": "Subscription Packages",
                "id": "BC954969D3172372D498D3BB2BA590A0",
                "alternative_code": "subpackages"
            },
            "description": "Desc",
            "categories_set":
            [
                {
                    "id": "7E44487354EC0C3DA78A3BB0AAF67085",
                    "category":
                    {
                        "name": "Residential 1",
                        "id": "AB7967530FB60ECC0C645B63739D6073",
                        "alternative_code": null
                    }
                }
            ],
            "alternative_code": null
        },
        {
            "tax_code": null,
            "udf_float_1": null,
            "udf_float_2": null,
            "brand": null,
            "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":
            [
                {
                    "effective_date": "2013-06-27T12:10:20",
                    "type": "BASE",
                    "name": "Base Price Plan",
                    "id": "6800B3AF1771693DBA2957BB0AC43D84",
                    "description": null,
                    "code": "BPP",
                    "expiration_date": "2014-04-21T09:21:57",
                    "version_num": 1
                }
            ],
            "id": "FEF0DD4C066AFF666253AD9E54DFB54A",
            "family": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "description",
            "log_information":
            {
                "updated_date": "2013-07-11T14:42:57",
                "created_date": "2013-07-11T11:49:46",
                "created_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "Master Partner",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "components_set":
            [
                {
                    "set_component":

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:

Include Page

	V4:product_identifier
	V4:product_identifier

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:

Include Page

	V4:product_type_identifier
	V4:product_type_identifier

product_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:

Include Page

	V4:product_brand_identifier
	V4:product_brand_identifier

product_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:

Include Page

	V4:product_family_identifier
	V4:product_family_identifier

product_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:

Include Page

	V4:product_category_identifier
	V4:product_category_identifier

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

Include Page

	V4:product_complete
	V4:product_complete

Examples

Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
               "message": null,
        "numberdescription": null,
        "code": "OK"
        },
     "iddata":
"F43EBDCE48CAADEC32CB26F59904ECCD",    [
        {
            "descriptionfamily":
   "Smart Card",        {
                "alternative_codename": null"LED TV",
                   },
   "id": "23B1B61652524515C440DF0CDC02E12B",
                "quantitydescription": 10null,
   
                "idalternative_code": "E9D9D62E6611C08A810EA051FF721842LET"
            },
    }        "brand":
    ],        {
    "type":             {"name": "Samsung",
                "nameid": "API unit testingE262BDC87F97B8DA8762D1507CCBF3C7",
                "iddescription": "5E7AB5975424269EADF67B19FBC3CA7F"null,
                "alternative_code": null"SAM"
            },
            "descriptionid": "description599C2CE3A1E25F69A8E2A367474E4336",
            "categories_set":code": "SSTV0000452"
        },
        {
        [    "family":
            {
                "name": "LED  TV",
                 "id": "805A1E4624C97E983654141C0542F3AF23B1B61652524515C440DF0CDC02E12B",
  
                 "categorydescription": null,
                "alternative_code": "LET"
 {            },
            "namebrand":
   "Residential 1",        {
                "idname": "AB7967530FB60ECC0C645B63739D6073Samsung",
                "id": "E262BDC87F97B8DA8762D1507CCBF3C7",
         "alternative_code": null      "description": null,
             }   "alternative_code": "SAM"
            },
             ]"id": "58DB60D0C959E2154B14CFA6EB90F88D",
            "alternative_code": null"SSTV0000453"
        }
    ]
}

Versions Compared

Old Version 19

New Version 20

Key

GET products/list

Resource URL

Parameters

Restrictions

Response Data

Examples

Example 1

GET products/list

Resource URL

Parameters

Restrictions

Response Data

Examples

Example 1

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

GET products/list

Resource URL

Parameters

Restrictions

Response Data

Examples

Example 1

GET products/list

Resource URL

Parameters

Restrictions

Response Data

Examples

Example 1