Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM/COM R9.0.0

...

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:

Include Page
V4:warranty_identifier
V4:warranty_identifier

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

(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:

Include Page
V4:group_identifier
V4:group_identifier

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

GET warranties/

...

get_covered_by_warranties

This method checks whether a physical good is , 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:

Include Page
V4:product_identifier
V4:product_identifier

product_type_identifier

(semi-optional)

Product Type Identifier

The identifier of the product type based on which the stock balance of all products of this type will be returned as a resultswhose warranty coverage is required. The allowed product type identifier fields are the following:

Include Page
V4:product_type_identifier
V4:product_type_identifier

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:

Include Page
V4:product_brand_identifier
V4:product_brand_identifier

product_family_identifier

(semi-optional)

Product Family Identifier

The identifier of the product family based on which the stock balance of all products of this family will be returned as a resultswhose warranty coverage is required. The allowed product family identifier fields are the following:

Include Page
V4:product_family_identifier
V4:product_family_identifier

installed_item_identifierInstalled Item Identifier

The identifier of the installed item whose warranty coverage is required. The allowed installed item identifier fields are the following:

Include Page
V4:installed_item_identifier
V4:installed_item_identifier

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

Include Page
V4:productwarranty_stock_balancecomplete
V4:productwarranty_stock_balancecomplete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue