Versions Compared

Key

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

Available from CRM.COM R9.0.0

Table of Contents
maxLevel2

...

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:

Include Page
V4:warranty_policy_identifier
V4:warranty_policy_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

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

Include Page
V4:group_identifier
V4:group_identifier

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:

Include Page
V4:unit_identifier
V4:unit_identifier

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:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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:

Include Page
V4:product_identifier
V4:product_identifier

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:

Include Page
V4:product_type_identifier
V4:product_type_identifier

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:

Include Page
V4:product_brand_identifier
V4:product_brand_identifier

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:

Include Page
V4:product_family_identifier
V4:product_family_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

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

Tip

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable

(semi-optional)

Accounts Receivable IdentifierThe accounts receivable of the customer who requests information about the sold installed items' warranty information.The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

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:

Include Page
V4:installed_item_identifier
V4:installed_item_identifier

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:

Include Page
V4:warranty_coverage_reason_identifier
V4:warranty_coverage_reason_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

...