Versions Compared

Key

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

Table of Contents
maxLevel2

Tip

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

...

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

...

Response Data

Include Page
V4:warehousewarranty_complete
V4:warehousewarranty_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

...

The identifier of the warehouse type related with warehouses that should be returned as a result. The allowed warehouse type identifier fields are the following:

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier

(semi-optional)

Identifier  

Include Page
V4:warehouse_type_identifierV4:warehouse_type_identifier

group_identifier

(semi-optional)

Identifier

The identifier of the group owning the warehouses 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

...

Response Data

Include Page
V4:warehousewarranties_complete
V4:warehousewarranties_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "name": "Sales Branch 1 - WHS Broken Items",
            "id": "45EAD5A1E31AFA22EF36AE9AE1A9534E",
            "alternative_code": "SB1_Broken"
        },
        {
            "name": "Broken TVs Warehouse",
            "id": "16A39274B2EB2C202EF0DB49A4F61492",
            "alternative_code": "BRTVWARE"
        }
    ]
} 

 

GET

...

warranties/

...

Tip

Available from CRM.COM R9.0.0

...

is_covered

This method checks whether a physical good is covered by a warranty or not. The method can be used for both traceable and non-traceable physical goods.

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 stock balance that should be returned as a resultwarranty 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 results. The allowed product type identifier fields are the following:

Include Page
V4:product_type_identifier
V4:product_type_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 results. The allowed product family identifier fields are the following:

Include Page
V4:product_family_identifier
V4:product_family_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

...