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

...

Include Page

	V4:product_complete
	V4:product_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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

...

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

...

Include Page

	V4:product_complete
	V4:product_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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"
        }
    ]
}

Versions Compared

Old Version 20

New Version 21

Key

Examples

GET products/list

Examples

Page Comparison

Versions Compared

Old Version 20

New Version 21

Key

Examples

GET products/list

Examples