GET warehouses/list

This method returns information related with warehouses. Multiple warehouse are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier

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

Deprecated from CRM.COM R18.0.0

Name

Type

Description

id

(semi-optional)

String

The ID of the warehouse type

name

(semi-optional)

String

The code of the warehouse type

alternative_code

(semi-optional)

String

The alternative code of the warehouse type

Deprecated from CRM.COM R18.0.0

group_identifier

(semi-optional)

Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

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

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved warehouse
name	String	The name of the retrieved warehouse
alternative_code	String	The alternative code of the retrieved warehouse
description	String	The description of the retrieved wareshouse
allow_negative_stock	Boolean	It defines if the warehouse allows negative stock or not Available from CRM.COM R12.3.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
type	Warehouse type object	The type of the retrieved warehouse
owned_by_group	Group object	The group owning the warehouse Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the warehouse Available from CRM.COM R18.0.0
privacy_level	Privacy level object	The privacy level of the warehouse Deprecated from CRM.COM R18.0.0
log_information	Log Information Object	The log information related with the retrieved warehouse
stock_balance	Set of stock balance object	The quantity of each product kept in the warehouse

Referred Objects Response Data

Deprecated from CRM.COM R18.0.0

warehouse_type object response data

Name	Type	Description
id	String	The ID of the retrieved warehouse type
name	String	The name of the retrieved warehouse type
alternative_code	String	The alternative code of the retrieved warehouse type
description	String	A description of the retrieved warehouse type

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

stock_balance object response data

Name	Type	Description
quantity	Number	The number of specified products kept in the warehouse
number_of_products_included_in_bundles	Number	The number of items included in physical good bundles Available from CRM.COM R8.0.0
product	Product Object	The product kept in the warehouse

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "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"
        }
    ]
}

Example 2

HTTP Method: GET

Request:

Response:

{
    "data": [
        {
            "alternative_code": "RW",
            "log_information": {
                "created_date": "2016-07-26T14:20:34",
                "updated_date": "2017-07-31T13:00:08"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "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": ""
    }
}