| Tip |
|---|
Available from CRM.COM R9.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET
...
warranty_policies/show
This method returns information related with a Warranty Policy. A single warranty is returned by each call
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| warranty_policy_identifier (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 |
...
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:
| ||||||
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:
| ||||||
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:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
accounts_receivable (semi-optional) | Accounts Receivable Identifier | The accounts receivable of the customer who requests information about the sold installed items' warranty information.The allowed accounts receivable identifier fields are the following:
| ||||||
| installed_item_identifier (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:
| ||||||
warranty_coverage_reason_identifier (optional) | Warranty Coverage Reason Identifier | 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 |
...