GET products/show
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
...
(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
...
Examples
Example 1
HTTP Method: GET
Request:
Response:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"tax_code":
{
"default": false,
"effective_date": null,
"percentage": 10,
"id": "1D3F3BA24EEBBD50E4B3289F0CB50885",
"description": "10",
"alternative_code": null
},
"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": "75F0A51A812B89014958AFD2BA476A6B",
"valid_from": "2014-03-01T00:00:00",
"valid_to": "2014-04-30T00:00:00"
}
],
"price_plans_set":
[
],
"id": "367A10D0A25DE1CCFAB298903DC082AE",
"family":
{
"name": "Movie Packages 3",
"id": "226492B49E346D0C3236EC740E7509F4",
"alternative_code": "1"
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"code": "test product",
"log_information":
{
"updated_date": "2014-03-27T10:43:49",
"created_date": "2013-07-23T16:01:39",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"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"
}
}
|
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,
"description": null,
"code": "OK"
},
"data":
[
{
"tax_code":
{
"default": false,
"effective_date": null,
"percentage": 10,
"id": "1D3F3BA24EEBBD50E4B3289F0CB50885",
"description": "10",
"alternative_code": null
},
"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": "367A10D0A25DE1CCFAB298903DC082AE",
"family":
{
"name": "Movie Packages 3",
"id": "226492B49E346D0C3236EC740E7509F4",
"alternative_code": "1"
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"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":
{
"number": null,
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"alternative_code": null
},
"quantity": 10,
"id": "E9D9D62E6611C08A810EA051FF721842"
}
],
"type":
{
"name": "API unit testing",
"id": "5E7AB5975424269EADF67B19FBC3CA7F",
"alternative_code": null
},
"description": "description",
"categories_set":
[
{
"id": "805A1E4624C97E983654141C0542F3AF",
"category":
{
"name": "Residential 1",
"id": "AB7967530FB60ECC0C645B63739D6073",
"alternative_code": null
}
}
],
"alternative_code": null
}
]
}| Panel |
|---|
|
| Child pages (Children Display) |
|---|
| all | true |
|---|
| excerpt | true |
|---|
| excerptType | simple |
|---|
|
|