Versions Compared

Key

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

This method returns information related with a warehouse. A single warehouse is returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

warehouse_identifier

(mandatory)

Identifier  

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

Include Page
V4:warehouse_identifier
V4:warehouse_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
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": "BRTVWARE",
        "udf_float_2": "BRTVWARE",
        "udf_date_1": "BRTVWARE",
        "udf_float_3": "BRTVWARE",
        "udf_date_2": "BRTVWARE",
        "udf_float_4": "BRTVWARE",
        "udf_date_3": "BRTVWARE",
        "udf_date_4": "BRTVWARE",
        "udf_string_1": "BRTVWARE",
        "name": "Broken TVs Warehouse",
        "udf_string_2": "BRTVWARE",
        "udf_string_3": "BRTVWARE",
        "privacy_level":
        {
            "number": "28",
            "hierarchy_level": 3,
            "name": "Moderate",
            "id": "2B5DBA0834813505EAEAC6440E337499"
        },
        "udf_string_4": "BRTVWARE",
        "udf_string_5": "BRTVWARE",
        "udf_string_6": "BRTVWARE",
        "owned_by_group":
        {
            "community_name": "Main Community",
            "name": "UK Offices",
            "id": "57ABCC226634B5B4C7AAA21C0132556E",
            "description": "UK Offices",
            "alternative_code": "UKO"
        },
        "udf_string_7": "BRTVWARE",
        "udf_string_8": "BRTVWARE",
        "type":
        {
            "name": "Warehouse Broken Items",
            "id": "4C6A9F2456D9D2388692D18FB2BED2CD",
            "description": null,
            "alternative_code": "WH_BrokenItems"
        },
        "id": "16A39274B2EB2C202EF0DB49A4F61492",
        "description": null,
        "alternative_code": "BRTVWARE"
    }
}
Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue