Retrieve Inventory Status of an Item

This JSON endpoint enables you to retrieve the inventory status of a single item at all Radial warehouses.

  • Inventory Segmentation: This functionality does not currently exist in the Inventory Status API. Response data is not be broken out by segment but is aggregated instead .

  • Lot Control: This functionality does not currently exist in the Inventory Status API. Response data will not be separated by lots but will instead be aggregated.

Details

Resource
GET /rom-availability-service/stores/{storeId}/inventoryStatus
Sample Request URL
http://lvststwsv04-06.us.gspt.net:19601/rom-availability-service/stores/TMSUS/inventoryStatus?itemID=21-RIT-AD1027&nodeId=TMSNA-DC445

Parameters

Parameter Description Required?
storeId Provided by Radial, this identifier indicates the sales channel. Yes
itemID The unique item identifier used within Radial systems. The required syntax is: <catalogId> + "-" + <clientItemId>. Yes
nodeType This value must be RADIAL_DC unless Radial advises otherwise. Yes, if nodeId is not included
nodeId Provided by Radial, this identifier represents the specific Radial warehouse. Yes, if nodeType is not included

Examples and Field Definitions

Copy 
curl -L -X GET 'https://tst04-epapi-na.gsipartners.com/rom-availability-service/stores/TMSUS/inventoryStatus?itemID=21-RIT-AD1027&nodeId=TMSNA-DC445' \
-H 'Authorization: Basic ********************************' \
-H 'apiKey: ********************************' 

HTTP Status 200: Success

Copy 
{
    "storeId": "TMSUS",
    "nodeIds": [
        "TMSNA-DC445"
    ],
    "lines": [
        {
            "lineId": "1",
            "itemId": "21-RIT-AD1027",
            "productClassId": "GOOD",
            "unitOfMeasureId": "EACH",
            "pendingQuantity": 0,
            "onHandQuantity": 15,
            "nodeDetails": [
                {
                    "nodeId": "TMSNA-DC445",
                    "nodeTypeId": "RADIAL_DC",
                    "onHandQuantity": 5,
                    "pendingQuantity": 0
                }
            ]
        }
    ]
}
 Field Name  Type  Comment
storeId String Contains the Radial assigned warehouse unique identifier.
nodeIds Array List of Node IdsStrings
lines Array List of Lines
lineId String Line ID
itemId String Optional. NodeDetails are returned only when itemId was provided.
productClassId String GOOD or nullable
unitOfMeasureId String EACH or nullable
availableQuantity Integer Line level available Quantity
pendingQuantity Integer Line level pending Quantity
onHandQuantity Integer Line level quantity on hand
nodeDetails Array List of Node Details
nodeId String The warehouse ID
nodeTypeId String The warehouse type; for example, RADIAL_DC
onHandQuantity Integer Node Detail level quantity on hand
availableQuantity Integer Node Detail level available Quantity
pendingQuantity Integer Node Detail level pending Quantity
segments Array  List of Segments
segmentId String The Segment ID
onHandQuantity Integer Segment level quantity on hand
pendingQuantity Integer Segment level available Quantity
lots Array List of Lot
lotId String The Lot ID
onHandQuantity Integer Lot level quantity on hand
pendingQuantity Integer Lot level pending Quantity