GET warranty_policies/list
Available from CRM.COM R9.0.0
This method returns information related with warranty policies. Multiple warranty policies are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be providing the warranty policy. The group is filtered against the warranty policy's allowed organisational units. The allowed group identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be providing the warranty policy. The unit is filtered against the warranty policy's allowed organisational units. The allowed unit identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
business_unit_identifier (optional) | Business Unit Identifier | The identifier of the business unit that will be providing the warranty policy. The business unit is filtered against the warranty policy's allowed organisational units. The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
job_type_identifier (optional) | Job Type Identifier | The identifier of the job type that will be used to provide the installed item under warranty. The retrieved warranty policies are filtered based on the list of warranty policies that are allowed to be provided by the specified job type. The allowed job type identifier fields are the following:
| ||||||||||||
product_identifier (optional) | Product Identifier | The identifier of the product whose warranty coverage is required. The product can only be a traceable physical good. The allowed product identifier fields are the following:
| ||||||||||||
product_type_identifier (optional) | Product Type Identifier | The identifier of the product type whose warranty coverage is required. Only product types for traceable physical goods can be specified. The allowed product type identifier fields are the following:
| ||||||||||||
product_brand_identifier (optional) | Product Brand Identifier | The identifier of the product brand whose warranty coverage is required. The allowed product brand identifier fields are the following:
| ||||||||||||
product_family_identifier (optional) | Product Family Identifier | The identifier of the product family whose warranty coverage is required. The allowed product family identifier fields are the following:
| ||||||||||||
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 warranty policy |
number | String | The number of the retrieved warranty policy |
name | String | The name of the retrieved warranty policy |
alternative_code | String | The alternative code of the retrieved warranty policy |
life_cycle_state | String | The life cycle state of the retrieved warranty policy. Supported values are EFFECTIVE and NOT EFFECTIVE |
description | String | The description of the retrieved warranty policy |
duration | Number | The duration of the warranty policy |
unit_of_time | String | The unit of time that measures the specified duration. The supported values are DAYS, WEEKS, MONTHS or YEARS |
replacement_coverage_policy | String | Defines how the Warranty Policy of the replaced physical good affects the physical good which replaces it. The available options are CARRY_OVER_WARRANTY, APPLY_NEW_WARRANTY, NO_WARRANTY |
effective_date | Date | The date from which the warranty policy can be applied on sold physical goods |
expiration_date | Date | The date until which the warranty policy can be applied on sold physical goods |
company_responsibilities | String | The warranty policy's company responsibilities |
customer_responsibilities | String | The warranty policy's customer responsibilities |
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_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 |
Set of physical goods covered | The physical goods which can be covered by the warranty policy | |
coverage_reasons_set | Set of Warranty Coverage Reasons | The Warranty Coverage Reasons which are applicable by the warranty policy. |
allowed_organisational_units_set | Set of unit Objects | The organisational units that can use the specific warranty policy Deprecated from CRM.COM R18.0.0 |
allowed_business_units_set | Set of Business Unit Objects | The business units that can use the specific warranty policy Available from CRM.COM R18.0.0 |
Log Information Object | The log information related with the retrieved warranty policy |
Referred Objects Response Data