GetItemInventoryQuantities (Method)

Description

Gets the inventory quantity for an item by Item ID in the specified unit of measure. Introduced in v2.20

Request (GetItemInventoryQuantitiesSoapIn)

The request body is of type GetItemInventoryQuantities.

Request Body Parameters

Name	Description	Data Type
Item_ID	The unique identifier of the item.	xml:int
UOM	The type of the unit of measure. Valid options are as follows: Stocking: "stocking", "STK", "S" or 1 Alternate: "alternate", "ALT", "A" or 2 Other: "other", "OTH", "O" or 3 Preferred: "preferred", "PREF", "P" or 0 or Specify the UOM by the unit label text prefixed with an @ sign. For example "@EA"	xml:anyType
Options		xml:string

Name

Description

Data Type

Item_ID

The unique identifier of the item.

xml:int

UOM

The type of the unit of measure.

Valid options are as follows:

Stocking: "stocking", "STK", "S" or 1
Alternate: "alternate", "ALT", "A" or 2
Other: "other", "OTH", "O" or 3
Preferred: "preferred", "PREF", "P" or 0

or

Specify the UOM by the unit label text prefixed with an @ sign. For example "@EA"

xml:anyType

Options

xml:string

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

MakeAJAXCall("Inventory.GetItemInventoryQuantities", {
    Item_ID:579, 
    UOM:0
},console.log);

200 Response (GetItemInventoryQuantitiesSoapOut)

The response body is of type GetItemInventoryQuantitiesResponse.

Response Body Parameters

Name	Description	Data Type
GetItemInventoryQuantitiesResult	{ "Data": { "StockCode": "A100", "UOM": "EA", "InventoryQty": 107806.000000, "DisplayString": "107,806 In Stock", "Warehouses": [ { "Warehouse": "E", "Description": "Eastern Zone Warehouse", "InventoryQty": 7031.0 }, { "Warehouse": "FG", "Description": "Finished Goods Warehouse", "InventoryQty": 4498.0 }, { "Warehouse": "N", "Description": "Northern Warehouse", "InventoryQty": 89422.0 }, { "Warehouse": "S", "Description": "Southern Warehouse", "InventoryQty": 6855.0 } ] }, "Result": { "Success": true, "Message": "Inventory results returned successfully.", "ElapsedTime": "54 ms" } }	xml:string

Name

Description

Data Type

GetItemInventoryQuantitiesResult

{
    "Data": {
        "StockCode": "A100",
        "UOM": "EA",
        "InventoryQty": 107806.000000,
        "DisplayString": "107,806  In Stock",
        "Warehouses": [
            {
                "Warehouse": "E",
                "Description": "Eastern Zone Warehouse",
                "InventoryQty": 7031.0
            },
            {
                "Warehouse": "FG",
                "Description": "Finished Goods Warehouse",
                "InventoryQty": 4498.0
            },
            {
                "Warehouse": "N",
                "Description": "Northern Warehouse",
                "InventoryQty": 89422.0
            },
            {
                "Warehouse": "S",
                "Description": "Southern Warehouse",
                "InventoryQty": 6855.0
            }
        ]
    },
    "Result": {
        "Success": true,
        "Message": "Inventory results returned successfully.",
        "ElapsedTime": "54 ms"
    }
}

xml:string