Retrieve Inventory Status of Multiple Items at a Single Warehouse

This JSON endpoint enables you to request the inventory status of multiple items at a single Radial warehouse.

  • 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
POST /rom-availability-service/stores/{storeId}/inventoryStatus
Sample Request URL
https://tst04-epapi-na.gsipartners.com/rom-availability-service/stores/TMSUS/inventoryStatus

Parameters

Parameter Description Required?
storeId Identifies the Radial warehouse. Yes

Examples and Field Definitions

Copy 
{
    "storeId": "TMSUS",
    "nodeIds": [
        "TMSNA-DC445",
        "TMSNA-DC447"
    ],
    "lines": [
        {
            "lineId": "1",
            "itemId": "21-RIT-AD1027"
        }
    ]
}

  • HTTP Status 200: Success

    Copy 
    {
        "storeId": "TMSUS",
        "nodeIds": [
            "TMSNA-DC445",
            "TMSNA-DC447"
        ],
        "lines": [
            {
                "lineId": "1",
                "itemId": "21-RIT-AD1027",
                "productClassId": "GOOD",
                "unitOfMeasureId": "EACH",
                "pendingQuantity": 0,
                "onHandQuantity": 15,
                "nodeDetails": [
                    {
                        "nodeId": "TMSNA-DC447",
                        "nodeTypeId": "RADIAL_DC",
                        "onHandQuantity": 10,
                        "pendingQuantity": 0
                    },
                    {
                        "nodeId": "TMSNA-DC445",
                        "nodeTypeId": "RADIAL_DC",
                        "onHandQuantity": 5,
                        "pendingQuantity": 0
                    }
                ]
            }
        ]
    }

  • HTTP Status 201: Created

  • HTTP Status 401: Unauthorized

  • HTTP Status 403: Forbidden

  • HTTP Status 404: Not Found

Field Definitions

Field Name Parent Tag Data Type Length Required? Description
storeId root String     Provided by Radial, this identifier indicates the sales channel.
nodeIds root List     Provided by Radial, this identifier represents a specific Radial warehouse. Populate this with a list of nodes you'd like the response to include, or leave it blank to get a response that includes all nodes.
lines root N/A     List of line details.
lines
lineId lines String     Line number.
itemId lines String     The unique identifier used within Radial systems.The syntax is: <catalogId> + "-" + <clientItemId>.
Field Name Parent Tag Data Type Length Required? Description
storeId root String     Provided by Radial, this identifier indicates the sales channel.
nodeIds root List     Provided by Radial, this identifier represents a specific Radial warehouse.
lines root N/A     List of line details.
lines
lineId lines String     Line number.
itemId lines String     The unique identifier used within Radial systems.The syntax is: <catalogId> + "-" + <clientItemId>.
pendingQuantity lines Integer     The quantity received but not put away across all nodes included in the response.
onHandQuantity lines Integer     The sellable quantity across all nodes included in the response.
nodeDetails lines String     List of node details.
nodeDetails
nodeId nodeDetails String     A unique identifier representing the specific sales channel and Radial warehouse combination.The syntax is: "storeId" + "-" + "node identifier"
nodeTypeId nodeDetails String     Identifies the type of node.This is always “RADIAL_DC” unless Radial indicates otherwise.
onHandQuantity nodeDetails Integer     The sellable quantity in the specified node.
pendingQuantity nodeDetails Integer     The quantity received but not put away in the specified node.