Available from CRM/COM R9.0.0
GET warranties/show
This method returns information related with a Warranty. A single warranty is returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| warranty_identifier (mandatory) | Identifier | The identifier of the warranty that should be returned as a result. The allowed warranty identifier fields are the following: Unable to render {include} The included page could not be found. |
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:
GET warranties/list
This method returns information related with warranties. Multiple warranties are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
group_identifier (semi-optional) | Identifier | The identifier of the group owning the warranties that should be returned as a result. The allowed group 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:
GET warranties/get_covered_by_warranties
This method checks whether a physical good, a product type or brand or family can be covered by a warranty or not. The method can be used for both traceable and non-traceable physical goods. The method returns all warranties that cover the physical good.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| product_identifier (semi-optional) | Product Identifier | The identifier of the product whose warranty coverage is required. The product might either be traceable or non-traceable. The allowed product identifier fields are the following:
| ||||||||||||
product_type_identifier (semi-optional) | Product Type Identifier | The identifier of the product type whose warranty coverage is required. The allowed product type identifier fields are the following:
| ||||||||||||
product_brand_identifier (semi-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 (semi-optional) | Product Family Identifier | The identifier of the product family whose warranty coverage is required. The allowed product family identifier fields are the following:
| ||||||||||||
| installed_item_identifier | Installed Item Identifier | The identifier of the installed item whose warranty coverage is required. The allowed installed item 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: