getItemAvailability

In SOAP web services, the getItemAvailability operation is used to retrieve the inventory availability for a specific list of items.

If the Multi-Location Inventory feature is enabled, this operation returns results for all locations. For locations that do not have any items available, only location IDs and names are listed in results.

SOAP Request

The following request shows the usage of the getItemAvailability operation.

            <soap:Body>
<platformMsgs:getItemAvailability>
   <platformMsgs:itemAvailabilityFilter>
      <platformCore:item>
         <platformCore:recordRef internalId="390" type="inventoryItem">
            <platformCore:name/>
         </platformCore:recordRef>
      </platformCore:item>
      <platformCore:lastQtyAvailableChange/>
   </platformMsgs:itemAvailabilityFilter>
</platformMsgs:getItemAvailability>
</soap:Body> 

          

SOAP Response

The following sample shows the response to the previous request.

            <soapenv:Body>
<getItemAvailabilityResponse xmlns="urn:messages_2025_1.platform.webservices.netsuite.com">
   <getItemAvailabilityResult
      xmlns="urn:core_2025_1.platform.webservices.netsuite.com">
      <status isSuccess="true"/>
      <itemAvailabilityList>
         <itemAvailability>
            <item internalId="390" type="inventoryItem">
               <name>testItem</name>
            </item>
            <locationId internalId="1" type="location">
               <name>East Coast</name>
            </locationId>
            <quantityOnHand>20.0</quantityOnHand>
            <onHandValueMli>0.0</onHandValueMli>
            <quantityCommitted>0.0</quantityCommitted>
            <quantityAvailable>20.0</quantityAvailable>
         </itemAvailability>
         <itemAvailability>
            <item internalId="390" type="inventoryItem">
               <name>testItem</name>
            </item>
            <locationId internalId="2" type="location">
               <name>West Coast</name>
            </locationId>
         </itemAvailability>
      </itemAvailabilityList>
   </getItemAvailabilityResult>
</getItemAvailabilityResponse>
</soapenv:Body> 

          

REST Request

In REST web services, you can get information about item availability by sending a GET request to retrieve a specific item.

            GET https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/inventoryItem/705?expandSubResources=true 

          

REST Response

The following sample shows a shortened response.

            {
    "links": [
        {
            "rel": "self",
            "href": "https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/inventoryItem/705"
        }
    ],
    "id": "705",
    "internalId": 705,
    "itemId": "Sample Boxes",
    "lastModifiedDate": "2024-04-25T15:06:00Z",
    "lastPurchasePrice": 0.0,
    "manufacturerState": "CA",
    "matchBillToReceipt": false,
    "multManufactureAddr": false,
    "nexTagProductFeed": false,
    "offerSupport": false,
   "onHandValueMli": "30",
   "quantityAvailable": "40",
   "quantityCommitted": "0",
   "quantityOnHand": "20", 
    "roundUpAsComponent": false,
    "saleUnit": "9",
    "seasonalDemand": false,
    "shipIndividually": false,
    "shoppingProductFeed": false,
    "shopzillaProductFeed": false,
    "stockUnit": "9",
    "totalValue": 0.0,
    "trackLandedCost": false,
    "weightUnits": "per Smp bx",
    "yahooProductFeed": false
} 

          

Related Topics

General Notices