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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of a product type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of a product brand

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

as_of_date_valid

(optional)

Date

Returns only the products that are valid based on specific date

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

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

Name	Type	Description
id	String	The ID of the retrieved product
code	String	The code of the retrieved product
alternative_code	String	The alternative code of the retrieved product
description	String	The description of the retrieved product
short_description	String	A short description of the retrieved product Available from CRM.COM R16.3.0 and onwards
long_description	String	A long description of the retrieved product Available from CRM.COM R12.3.0 and CRM.COM* R13.1.0 onwards*
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
non_stockable	Boolean	The flag shoes if the retrieved product is non-stockable Available from CRM.COM R18.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
type	Product Type Object	The type of the retrieved product
brand	Product Brand Object	The brand of the retrieved product
family	Product Family Object	The product family of the retrieved product
log_information	Log Information Object	The Log Information related with the retrieved product
bundle_restrictions	Bundle Restrictions Object	The bundle restrictions of the new product This parameter is applicable only if the product is classified as a flexible bundle Available from CRM.COM R14.0.0
price_plans_set	Set of Price Plans Object	The Price Plans containing the retrieved product
validity_set	Set of Product Validity Object	The Product validity of the retrieved product (If is empty then the product is always valid)
categories_set	Set of Product to Product Category Object	The Product Categories of the retrieved product
components_set	Set of Product Components Object	The components of the retrieved product. This is applicable only if the product type composition method is set to fixed or flexible bundle
usage_service_catalogs_set	Set of Usage Service Catalogs Object	The Usage Service Catalogs containing the retrieved product. Available only when the retrieved product is a usage service. Available from CRM.COM R9.0.0
tax_rate_set	Set of Tax Rate Objects	The TAX Rate of the retrieved product Available from CRM.COM R14.0.0
vat_rate_set	Set of Vat Rate Objects	The VAT Rate of the retrieved product Deprecate from CRM.COM R17.0.0
metadata_set	Set of Metadata Attributes	The set of metadata attributes available for the retrieved product Available from CRM.COM R15.0.0
allowed_metadata_set	Set of Metadata Attributes	The allowed set of metadata attributes whose values will be set on the installed items. Available only for traceable physical goods Available from CRM.COM R15.0.0

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

product_brand object data response

Name	Type	Description
Id	String	The ID of the retrieved product brand
name	String	The Name of the retrieved product brand
alternative_code	String	The Alternative Code of the retrieved product brand
description	String	The Description of the retrieved product brand

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

tax_rate response data object

Name	Type	Description
id	String	The ID of the retrieved Tax rate
name	String	The Name of the retrieved Tax rate
alternative_code	String	The Alternative Code of the retrieved Tax rate
description	String	The Description of the retrieved Tax rate

vat_rate response data object

Name	Type	Description
Id	String	The ID of the retrieved vat rate
name	String	The Name of the retrieved vat rate
alternative_code	String	The Alternative Code of the retrieved vat rate
description	String	The Description of the retrieved vat rate

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

price_plan object data response

Name	Type	Description
Id	String	The ID of the retrieved price plan
name	String	The Name of the retrieved price plan
code	String	The Code of the retrieved price plan
description	String	The Description of the retrieved price plan
type	String	The Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date	Date	The Effective Date of the retrieved price plan
expiration_date	Date	The Expiration Date of the retrieved price plan
currency	Currency Object	The Currency of the retrieved price plan Available from CRM.COM R14.2.0

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

product_validity object data response

Name	Type	Description
id	String	The ID of the product validity
valid_from	Date	The date that the product should become valid
valid_to	Date	The date that the product should become invalid. This is optional as a product can be valid for ever, starting from a specific date

product_to_product_category object data response

Name	Type	Description
Id	String	The ID of the retrieved product to product category component
category	Product Category Object	The product category of the retrieved product to product category component

Referred Objects Response Data

product_category response data object

Name	Type	Description
Id	String	The ID of the retrieved product category
name	String	The Name of the retrieved product category
code	String	The code of the retrieved product category
description	String	The Description of the retrieved product category

product_component object data response

Name	Type	Description
Id	String	The ID of the retrieved product component
quantity	float	The quantity of the product component. Available only for fixed bundle products
is_mandatory	Boolean	Defines whether the product should be provided as mandatory for the bundle or not Available from CRM.COM R17.0.0
min_quantity	float	The minimum required quantity of the product component. Available only for flexible bundle products
max_quantity	float	The minimum required quantity of the product component. Available only for flexible bundle products
product	Product Object	The product of the retrieved product component
product_type	Product Type Object	The product type of the retrieved product components. Available only for flexible bundle products
product_family	Product Family Object	The product family of the retrieved product components. Available only for flexible bundle products

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

product_bundle_restrictions object data response

Name

Type

Description

number_of_product_types_restriction

Number

Restricts the number of product types that products can be used from

Applicable only for FLEXIBLE bundle products

number_of_product_families_restriction

Number

Restricts the number of product families that products can be used from

Applicable only for FLEXIBLE bundle products

usage_service_catalog object data response

Name	Type	Description
Id	String	The ID of the retrieved usage service catalog
name	String	The Name of the retrieved usage service catalog
alternative_code	String	The Alternative Code of the retrieved usage service catalog
description	String	The Description of the retrieved usage service catalog
effective_date	Date	The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0
expiration_date	Date	The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0

upsells object data response

Name	Type	Description
upsell_product	String	The product which is considered as an upsell to the existing product
upsell_priority	Integer	The priority which can be used by the 3rd party system to decide the order by which the product will be displayed in relation to other upsell products

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

cross_sells object data response

Name

Type

Description

cross_sell_product

String

The product which is considered as a cross-sell to the existing product.

This is bidirectional, meaning that if Product A is defined as a cross-sell to Product B, then product B will be available as a cross-sell of product A

cross_sell_priority

Integer

The priority which can be used by the 3rd party system to decide the order by which the product will be displayed in relation to other cross-sell products

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

metadata attribute value response object

Name	Type	Description
id	String	The ID of the retrieved metadata field, related to the entity for which it is retrieved
key	String	The key of the retrieved metadata field, related to the entity for which it is retrieved
name	String	The name of the retrieved metadata field, related to the entity for which it is retrieved
description	String	The description of the retrieved metadata field, related to the entity for which it is retrieved
type	String	The type of the retrieved metadata field, related to the entity for which it is retrieved. Available values are: STRING INTEGER FLOAT BOOLEAN DATE
value	String	The value of the specific metadata field, related to the entity for which it is retrieved

allowed metadata attribute response object

Name	Type	Description
id	String	The ID of the retrieved metadata attribute
key	String	The key of the retrieved metadata attribute
name	String	The name of the retrieved metadata attribute
description	String	The description of the metadata attribute
type	String	The type of the retrieved metadata. Available values are: STRING INTEGER FLOAT BOOLEAN DATE
is_mandatory	Boolean	Defines whether the metadata attribute is mandatory or not
values_set	Value set Object	The values available to be set for this metadata attribute. (Configurable)
default_value	depends on the type	The default value which is applicable if a value set is defined.

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "udf_string_10": null,
            "usage_service_catalogs_set":
            [
                {
                    "id": "9F9CF9074DB2406B994DD34EEAF44BA5",
                    "name": "Api Test",
                    "description": "Test Update From Api",
                    "alternative_code": "A_T"
                }
            ],
            "udf_float_1": null,
            "udf_string_11": null,
            "udf_float_2": null,
            "udf_string_12": null,
            "brand": null,
            "udf_float_3": null,
            "udf_string_13": null,
            "udf_float_4": null,
            "udf_string_14": 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":
            [
                {
                    "valid_from": "2015-09-01T00:00:00",
                    "valid_to": "2015-09-15T00:00:00"
                }
            ],
            "price_plans_set":
            [
                {
                    "effective_date": "2014-11-01T16:27:10",
                    "type": "CONDITIONAL",
                    "id": "76E6BC7F8D66F9F97466C457E97DAF72",
                    "name": "Aluxsat Conditional Price Plan",
                    "description": "Aluxsat Conditions",
                    "code": "AlxCPP",
                    "expiration_date": "2015-09-17T00:00:00"
                },
                {
                    "effective_date": "2014-09-05T17:59:41",
                    "type": "CONDITIONAL",
                    "id": "124FF42485290166C9F53A4761AC05A0",
                    "name": "2313",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "asdas",
                    "expiration_date": "2015-06-25T00:00:00"
                },
                {
                    "effective_date": "2014-10-01T00:00:00",
                    "type": "BASE",
                    "id": "3A6ADF02D2FA95A12280B736610279FF",
                    "name": "Aluxsat BASIC Price PLan",
                    "description": "Pers",
                    "code": "ABPP",
                    "expiration_date": "2014-12-18T15:25:43"
                },
                {
                    "effective_date": "2014-08-05T00:00:00",
                    "type": "BASE",
                    "id": "B517A9F2D3E988F7321F2BDA9AC18051",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": "2014-08-07T00:00:00"
                },
                {
                    "effective_date": "2014-08-07T00:00:00",
                    "type": "BASE",
                    "id": "7CB9E81A214B0F25EEECE223B608DCCC",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": "2014-09-12T10:21:54"
                },
                {
                    "effective_date": "2014-08-04T00:00:00",
                    "type": "BASE",
                    "id": "B327AC0436E36F7C70B1CC50B795564D",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": "2014-08-05T00:00:00"
                },
                {
                    "effective_date": "2015-09-17T00:00:00",
                    "type": "CONDITIONAL",
                    "id": "031EFE5DDD874C56A0E68A0FC2961E70",
                    "name": "Aluxsat Conditional Price Plan",
                    "description": "Aluxsat Conditions",
                    "code": "AlxCPP",
                    "expiration_date": null
                },
                {
                    "effective_date": "2014-10-27T15:41:29",
                    "type": "CONDITIONAL",
                    "id": "D2B34625C75671E53C2380E53531B9E1",
                    "name": "Aluxsat Conditional Price Plan",
                    "description": "Aluxsat Conditions",
                    "code": "AlxCPP",
                    "expiration_date": "2014-11-01T16:27:10"
                },
                {
                    "effective_date": "2014-12-18T15:25:43",
                    "type": "BASE",
                    "id": "F7C3E67460E445101E7642D2C8C60AF9",
                    "name": "Aluxsat BASIC Price PLan",
                    "description": "Pers",
                    "code": "ABPP",
                    "expiration_date": "2018-10-01T00:00:00"
                }
            ],
            "id": "17688F614343868F71F913924021415C",
            "family": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "3 Days Left",
            "log_information":
            {
                "updated_date": "2015-09-01T12:30:57",
                "created_date": "2014-08-04T14:25:02",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "vat_rate":
            {
                "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                "name": "Standard 10%",
                "description": null,
                "alternative_code": "S10"
            },
            "components_set":
            [
            ],
            "type":
            {
                "service_type": "USAGE",
                "physical_good_type": "NONTRACEABLE",
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "78F758444F6B8437F1A27F61D1BE84A5",
                "name": "VOD",
                "description": "Video on Demand Movies",
                "alternative_code": "VOD"
            },
            "description": "3 Days Left",
            "alternative_code": "3DL",
            "categories_set":
            [
            ]
        },
        {
            "udf_string_10": null,
            "usage_service_catalogs_set":
            [
                {
                    "id": "C5C8A8B9691C469A813120EE648054F7",
                    "name": "34",
                    "description": null,
                    "alternative_code": "34"
                },
                {
                    "id": "9F9CF9074DB2406B994DD34EEAF44BA5",
                    "name": "Api Test",
                    "description": "Test Update From Api",
                    "alternative_code": "A_T"
                },
                {
                    "id": "57FD4AA45E024D2FA6D8A67B41967CF1",
                    "name": "Api Test 2",
                    "description": "Test From Api",
                    "alternative_code": "A_T_2"
                },
                {
                    "id": "65407FBD15184DEAA6E5AC84EEBD558D",
                    "name": "Exet Usage Catalog",
                    "description": null,
                    "alternative_code": "EUC"
                },
                {
                    "id": "61BEE068A3FE4E0A89A309A0C6632A68",
                    "name": "test",
                    "description": "test audit trail log",
                    "alternative_code": "T_1"
                },
                {
                    "id": "545BF62B72534BEAAFEC295CCCE9E248",
                    "name": "4176",
                    "description": null,
                    "alternative_code": "4"
                },
                {
                    "id": "5E5AD41E3939402085F421612C20B0A9",
                    "name": "test l",
                    "description": null,
                    "alternative_code": "tl"
                }
            ],
            "udf_float_1": null,
            "udf_string_11": null,
            "udf_float_2": null,
            "udf_string_12": null,
            "brand": null,
            "udf_float_3": null,
            "udf_string_13": null,
            "udf_float_4": null,
            "udf_string_14": 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": "02192DC60AF606C2124118AABCBFAAAA",
            "family": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "Serendipity",
            "log_information":
            {
                "updated_date": "2014-08-04T14:25:53",
                "created_date": "2014-08-04T14:25:37",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429"
                },
                "updated_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429"
                }
            },
            "vat_rate":
            {
                "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                "name": "Standard 10%",
                "description": null,
                "alternative_code": "S10"
            },
            "components_set":
            [
            ],
            "type":
            {
                "service_type": "USAGE",
                "physical_good_type": "NONTRACEABLE",
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "78F758444F6B8437F1A27F61D1BE84A5",
                "name": "VOD",
                "description": "Video on Demand Movies",
                "alternative_code": "VOD"
            },
            "description": "Serendipity",
            "alternative_code": "SRDP",
            "categories_set":
            [
            ]
        },
	....
 ]
}

Example 2

HTTP Method: GET

Request:

Response:

 {
  "data": [
    {
      "code": "CREED",
      "price_plans_set": [],
      "type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "udr_type": {
          "alternative_code": "V",
          "name": "VOD",
          "description": null,
          "id": "B3CFC986221548279752B1ABC6F4C480"
        },
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "usage_service_catalogs_set": [
        {
          "alternative_code": "TM",
          "name": "Test MA USC",
          "description": null,
          "id": "9983915194B44DAF8BFBADDA5E983790"
        },
        {
          "alternative_code": "IUSC",
          "name": "Icareus Usage Service Catalog",
          "description": "Icareus Usage Service Catalog",
          "id": "AE91A25BC50C430691652C258026A8FC"
        },
        {
          "alternative_code": "A_T",
          "name": "Api Test",
          "description": "Test From Api",
          "id": "0D99B9B4147440BFA2CD34E2323B239F"
        },
        {
          "alternative_code": "UTM",
          "name": "USC Test MA",
          "description": null,
          "id": "EE4119049F7F4D8A90E381A68B35B00A"
        },
        {
          "alternative_code": "T",
          "name": "Test",
          "description": null,
          "id": "EF486F67F0ED4CEE894023C44783A863"
        },
        {
          "alternative_code": "6",
          "name": "657567",
          "description": null,
          "id": "51F28BDD4A52422AADE8B75322A9EA43"
        },
        {
          "alternative_code": "USC",
          "name": "Usage Service Catalog",
          "description": null,
          "id": "4B959F05F34F443D866D3C09FE69302C"
        },
        {
          "alternative_code": "M",
          "name": "Movies",
          "description": null,
          "id": "364216EABA064FEDAF5E07F28D2CB08D"
        }
      ]
    },
    {
      "code": "Serendipity",
      "price_plans_set": [],
      "type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "udr_type": {
          "alternative_code": "V",
          "name": "VOD",
          "description": null,
          "id": "B3CFC986221548279752B1ABC6F4C480"
        },
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "usage_service_catalogs_set": [
        {
          "alternative_code": "T",
          "name": "Test",
          "description": null,
          "id": "EF486F67F0ED4CEE894023C44783A863"
        },
        {
          "alternative_code": "A_Tet3",
          "name": "Api Test ET3",
          "description": "Test From Api",
          "id": "6B4B167D112F4BFCA8B92E61A07F928A"
        },
        {
          "alternative_code": "A_Tet2",
          "name": "Api Test ET2",
          "description": "Test From Api",
          "id": "FBC1A747E0A24A43A347B6C15802DC2C"
        },
        {
          "alternative_code": "A_Tet",
          "name": "Api Test ET",
          "description": "Test From Api",
          "id": "95A5422E31284FB081106645354D6F70"
        },
        {
          "alternative_code": "A_T",
          "name": "Api Test",
          "description": "Test From Api",
          "id": "0D99B9B4147440BFA2CD34E2323B239F"
        },
        {
          "alternative_code": "asu",
          "name": "Testing add/save usc",
          "description": null,
          "id": "46A16CC5A4464ABFA46C8C58C3DDBF99"
        },
        {
          "alternative_code": "IUSC",
          "name": "Icareus Usage Service Catalog",
          "description": "Icareus Usage Service Catalog",
          "id": "AE91A25BC50C430691652C258026A8FC"
        },
        {
          "alternative_code": "M",
          "name": "Movies",
          "description": null,
          "id": "364216EABA064FEDAF5E07F28D2CB08D"
        },
        {
          "alternative_code": "A_Tet4",
          "name": "Api Test ET4",
          "description": "Test From Api",
          "id": "D3DBE2ACDF054FE09E58ED4C6BA764E7"
        },
        {
          "alternative_code": "USC",
          "name": "Usage Service Catalog",
          "description": null,
          "id": "4B959F05F34F443D866D3C09FE69302C"
        },
        {
          "alternative_code": "T_1",
          "name": "Test MA",
          "description": null,
          "id": "6266FE95E731484E82263A9A69331095"
        }
      ]
    },
    {
      "code": "MAD MAX",
      "price_plans_set": [],
      "type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "udr_type": {
          "alternative_code": "V",
          "name": "VOD",
          "description": null,
          "id": "B3CFC986221548279752B1ABC6F4C480"
        },
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "usage_service_catalogs_set": [
        {
          "alternative_code": "M",
          "name": "Movies",
          "description": null,
          "id": "364216EABA064FEDAF5E07F28D2CB08D"
        },
        {
          "alternative_code": "USC",
          "name": "Usage Service Catalog",
          "description": null,
          "id": "4B959F05F34F443D866D3C09FE69302C"
        },
        {
          "alternative_code": "TM",
          "name": "Test MA USC",
          "description": null,
          "id": "9983915194B44DAF8BFBADDA5E983790"
        },
        {
          "alternative_code": "A_Tet",
          "name": "Api Test ET",
          "description": "Test From Api",
          "id": "95A5422E31284FB081106645354D6F70"
        },
        {
          "alternative_code": "T",
          "name": "Test",
          "description": null,
          "id": "EF486F67F0ED4CEE894023C44783A863"
        },
        {
          "alternative_code": "IUSC",
          "name": "Icareus Usage Service Catalog",
          "description": "Icareus Usage Service Catalog",
          "id": "AE91A25BC50C430691652C258026A8FC"
        },
        {
          "alternative_code": "E",
          "name": "edrydrydry",
          "description": null,
          "id": "2A206F3B2F14412D919BE0DBAC351A4C"
        }
      ]
    },
    {
      "code": "Tax Test Duplicate",
      "price_plans_set": [],
      "type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "udr_type": {
          "alternative_code": "V",
          "name": "VOD",
          "description": null,
          "id": "B3CFC986221548279752B1ABC6F4C480"
        },
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "usage_service_catalogs_set": []
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}