Versions Compared

Old Version 27

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 28

changes.mady.by.user Former user

Saved on

Key

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

Table of Contents
maxLevel2

...

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 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
      {
          "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
        {
            "name": "Samsung",
            "id": "E262BDC87F97B8DA8762D1507CCBF3C7",
            "description": null,
           "udf_string_3": null,
                      "alternative_code": "SAM"
        },
        "udf_string_412": null,
          
        "udf_stringfloat_52": null,
                  "udf_string_613": null,
             "udf_string_7      "udf_float_3": null,
                  "udf_string_814": null,
                  "udf_stringfloat_94": null,
            "validity_set":            [            ],            "priceudf_plansstring_set15":            [
               {
                   "effective_date": "2014-06-25T00:00:00",
                   "type": "BASE",
                   "name": "Main Price Plan2014",
                   "id": "361A5B0377E4D98A089314C1281A5C47",
                   "description": "Main Price PLan for 2014",
                   "code": "MPP14",
                   "expiration_datenull,
        "udf_string_1": null,
        "udf_string_16": null,
        "udf_string_2": null,
        "udf_string_3": null,
                   "version_num": 0                },                {                    "effectiveudf_string_date4": "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":
                       {
                          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": null,
                          "TRACEABLE",
            "service_type": "TERMED",
                          null,
            "used_for_provisioning": true,
                          : true,
            "composition_method": "FLAT",
                                      "classification": "SERVICESPHYSICALGOODS",
                                      "name": "Subscription servicesDecoders",
                          
            "id": "600438B64B0F05AB3D020C902674949FB4A1396AE3D1384B304A0FEB22F7BA50",
                            "description": "Subscription services",                            "alternative_code": "SS"
                       },
                       "id      "description": "4D55A6EC2FF25A44B9945B88940AF1A0Decoders",
                         "description": "Sports 2 Packages",                        "code": "Sports 2",                        "alternative_code": "S2D"
                          },
                    "max_quantity": "4206E0D6D6B95F1568A1923E794C700B",                    "min_quantity": "4206E0D6D6B95F1568A1923E794C700B",                    "quantitydescription": null"Athina STB",
                   "id": "4206E0D6D6B95F1568A1923E794C700B"                },                {                    "categories_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",
                      
        [
            {
                "id": "37D7C2B9C1012296BB1763ACADEA8807",
                "category":
                {
                    "name": "Residential 2",
                    "id": "12BE7A9BC9CE6A189C268F6440A60AB2",
                    "description": "Residential 2",
                    "code": "22"
                }
            }
        ],
        "alternative_code": null
                   }
              "A-STB"
    }
           ],}
          
"alternative_code":
"GPP"
       }     }      

 

GET products/list

This method returns information related with products. Multiple products are returned by each call

...

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

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

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

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

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

...