Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

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

...

Resource URL

Parameters

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 2

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "alternative_code": "RW",
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2016-07-26T14:20:34",
            "updated_date": "2017-07-31T13:00:08",
            "updated_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "Community",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "description": null,
        "udf_date_2": null,
        "type": {
            "alternative_code": "RW",
            "name": "Rentals WHT1",
            "description": null,
            "id": "7237E63DA6CD46498EBEC2B2DE768B05"
        },
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "id": "919F0F2DA6D94FABA60180D91E1F36B7",
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "allow_negative_stock": true,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": {
            "number": "14",
            "name": "PL Group A_Share_Low",
            "id": "9DCEFDA9D56145978C265085CD146810",
            "hierarchy_level": 1
        },
        "udf_string_1": null,
        "stock_balance": [
            {
                "product": {
                    "code": "Modem",
                    "product_type": {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "Physical Good",
                        "composition_method": "FLAT",
                        "name": "Physical Good",
                        "description": null,
                        "id": "5B6DAF4AD7C94C4D9C3B49950E10B256",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "M_2",
                    "description": "Modem",
                    "id": "01BEEA0C9B7246E79CAF6E569A8C6ECF"
                },
                "quantity": 2
            },
            {
                "product": {
                    "code": "Smartcard",
                    "product_type": {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "S",
                        "composition_method": "FLAT",
                        "name": "SMARTCARD",
                        "description": "SMARTCARD",
                        "id": "D6BE0209EC0149989A89972CE889DF8B",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "SC1",
                    "description": "asd",
                    "id": "4F656ED5DAC44168B0805227881202CD"
                },
                "quantity": 2
            },
            {
                "product": {
                    "code": "Decoder",
                    "product_type": {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "D",
                        "composition_method": "FLAT",
                        "name": "Decoder",
                        "description": null,
                        "id": "57F09D0D589D494E92768EE9F8D2D2A5",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "D1",
                    "description": "asd",
                    "id": "718DE79EDA5843238559B5360E705B10"
                },
                "quantity": 5
            }
        ],
        "name": "Rentals WH1",
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}