GET service_requests/configuration/physical_goods/list

Available from CRM.COM R9.0.0

This method returns the physical goods that are allowed to be used by service requests of specific type. Multiple physical goods are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

service_request_type_identifier

(mandatory)

Service Request Type Identifier

The identifier of the type of the service request that will be using the physical goods. The physical goods are filtered against the allowed physical goods of the specified type. The allowed service request type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the service request type

name

(semi-optional)

String

The name of the service request type

alternative_code

(semi-optional)

String

The alternative code of  the service request type

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

Response Data

NameType Description

id

String

The ID of the retrieved service request type physical good

product

Product Object

The actual product provided by the service request type physical good

product_typeProduct Type ObjectThe actual product type provided by the service request type physical good

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

 

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "product_type":
            {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": true,
                "classification": "PHYSICALGOODS",
                "composition_method": "FLAT",
                "name": "Decoders",
                "id": "B4A1396AE3D1384B304A0FEB22F7BA50",
                "description": "Decoders",
                "alternative_code": "D"
            },
            "id": "0D06FBC11A4D8FF8F1102DB115F73207",
            "product": null
        },
        {
            "product_type": null,
            "id": "869A69597600C9CE9564D1BB988C92DD",
            "product":
            {
                "product_type":
                {
                    "service_type": null,
                    "physical_good_type": "TRACEABLE",
                    "used_for_provisioning": false,
                    "classification": "PHYSICALGOODS",
                    "composition_method": "FLAT",
                    "id": "6173FC99331504AD1ACB5D697D54DA8C",
                    "name": "Smartcards",
                    "description": "Smartcards",
                    "alternative_code": "SC"
                },
                "id": "EAC7A30429364176616CFEF5DF709941",
                "description": "Smartcard 1",
                "code": "Smartcard 1",
                "alternative_code": "SC1"
            }
        },
        {
            "product_type":
            {
                "service_type": null,
                "physical_good_type": "NONTRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FLAT",
                "name": "TV Guide",
                "id": "E147D48A6B94C942036314DF146C5E9A",
                "description": "Channel Guide - Hard Copy",
                "alternative_code": "TVG"
            },
            "id": "29F4FE24599946C999112884846577A4",
            "product": null
        },
        {
            "product_type":
            {
                "service_type": null,
                "physical_good_type": "NONTRACEABLE",
                "used_for_provisioning": true,
                "classification": "PHYSICALGOODS",
                "composition_method": "FIXEDBUNDLE",
                "name": "NPG Bundle",
                "id": "AD60CE70C4BF4B9BB323597B816DB878",
                "description": null,
                "alternative_code": "NB"
            },
            "id": "91769DD3549C43EC88542404471E81C2",
            "product": null
        },
        {
            "product_type":
            {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FIXEDBUNDLE",
                "name": "TPG Bundle",
                "id": "82DC9C7986C84E7A9B7F73BC5C144DA5",
                "description": null,
                "alternative_code": "TB"
            },
            "id": "C7510884F7224B98B8EE329D25EF9FEB",
            "product": null
        },
        {
            "product_type":
            {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FIXEDBUNDLE",
                "name": "TPG Bundle 3",
                "id": "900131A568ED49329AD016B651702032",
                "description": null,
                "alternative_code": "TB3"
            },
            "id": "9F6B9CFDB84D4758AF4FA9A1E49C33BE",
            "product": null
        }
    ]
}