Versions Compared

Key

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

Table of Contents
maxLevel2

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

...

(mandatory)

...

Identifier  

The identifier of the warranty that should be returned as a result. The allowed warranty 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

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

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

...

(semi-optional)

...

Identifier  

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:

...

group_identifier

(semi-optional)

...

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

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 warehouses/get_stock_balance_per_product

Tip

Available from CRM.COM R9.0.0

This method returns information related with the stock balance of a specific product across all warehouses. 

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(semi-optional)

...

Product Identifier  

The identifier of the product whose stock balance that should be returned as a result. The allowed product identifier fields are the following:

...

product_type_identifier

(semi-optional)

...

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:

...

product_family_identifier

(semi-optional)

...

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:

...

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:

 
Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue