| Tip |
|---|
Available from CRM.COM R9.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET warranties_policies/show
This method returns information related with a Warranty Policy. A single warranty 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 warranty policy that should be returned as a result. The allowed warranty policy 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
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET warranty_policies/list
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 |
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
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET warranty_policies/get_warranty_availability_per_physical_good
This method checks whether a physical good, or product type or brand or family can be covered by a warranty policy or not. The method returns all warranty policies that provide coverage for the requested physical goods.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-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
(semi-optional)
...
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
(semi-optional)
...
The identifier of the product brand whose warranty coverage is required. The allowed product brand identifier fields are the following:
...
product_family_identifier
(semi-optional)
...
The identifier of the product family whose warranty coverage is required. The allowed product family 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
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET warranty_policies/get_installed_item_warranty
This method checks whether installed items sold to customers are covered by warranty policies or not. The method can be used for checking installed items coverage which is required in Jobs which perform Swap Subscription Installed Item actions. Depending on the parameters, the method might return more than one installed item's warranty information.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
accounts_receivable
(semi-optional)
...
(semi-optional)
...
Installed Item Identifier
The identifier of the installed item whose warranty coverage is required. The allowed installed item identifier fields are the following:
...
job_type_identifier
(semi-optional)
...
The identifier of the job type for which installed item warranty coverage is required. Only job types with fulfillment scope SWAP_SUBSCRIPTION_INSTALLED_ITEMS can be specified. The allowed job type identifier fields are the following:
...
warranty_coverage_reason_identifier
(semi-optional)
...
The identifier of the warranty policy's coverage reason. The coverage reason represents the replacement reason so if set the installed item's warranty should support this coverage reason. The allowed warranty coverage reason 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
HTTP Method: GET
Request:
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Panel | ||||||
| ||||||
|