Inventory Status

The Inventory Status API provides information about the inventory status of one or more physical products. In contrast with getting inventory status by expanding the fields in the Products API, the Inventory Status API provides faster access to product inventory status. The Inventory Status API is a subresource of the Products API. The inventory status call does not support Digital Rights Inventory. 

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: application/xml
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<products uri="https://api.digitalriver.com/v1/shoppers/me/products/inventory-status">
   <inventoryStatus uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID/inventory-status">
      <product uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID">
         <id>product_ID</id>
         <externalReferenceId>external_reference_ID</externalReferenceId>
         <companyId>demosft1</companyId>
      </product>
      <availableQuantity>2147483647</availableQuantity>
      <availableQuantityIsEstimated>false</availableQuantityIsEstimated>
      <productIsInStock>true</productIsInStock>
      <productIsAllowsBackorders>true</productIsAllowsBackorders>
      <productIsTracked>false</productIsTracked>
      <requestedQuantityAvailable>true</requestedQuantityAvailable>
      <status>PRODUCT_INVENTORY_IN_STOCK</status>
      <statusIsEstimated>false</statusIsEstimated>
      <expectedInStockDate/>
      <customStockMessage/>
   </inventoryStatus>
   <inventoryStatus uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID/inventory-status">
      <product uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID">
         <id>product_ID</id>
         <externalReferenceId>external_reference_ID</externalReferenceId>
         <companyId>demosft1</companyId>
      </product>
      <availableQuantity>2147483647</availableQuantity>
      <availableQuantityIsEstimated>false</availableQuantityIsEstimated>
      <productIsInStock>true</productIsInStock>
      <productIsAllowsBackorders>true</productIsAllowsBackorders>
      <productIsTracked>false</productIsTracked>
      <requestedQuantityAvailable>true</requestedQuantityAvailable>
      <status>PRODUCT_INVENTORY_IN_STOCK</status>
      <statusIsEstimated>false</statusIsEstimated>
      <expectedInStockDate/>
      <customStockMessage/>
   </inventoryStatus>
</products>
			
					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: application/xml
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<inventoryStatus uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID/inventory-status">
   <product uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID"/>
          <id>product_ID</id>
          <externalReferenceId>external_reference_ID</externalReferenceId>
          <companyId>demosft1</companyId>
   </product>
   <availableQuantity>-1</availableQuantity>
   <availableQuantityIsEstimated>false</availableQuantityIsEstimated>
   <productIsInStock>false</productIsInStock>
   <productIsAllowsBackorders>true</productIsAllowsBackorders>
   <productIsTracked>true</productIsTracked>
   <requestedQuantityAvailable>false</requestedQuantityAvailable>
   <status>PRODUCT_INVENTORY_BACKORDERED</status>
   <statusIsEstimated>false</statusIsEstimated>
   <expectedInStockDate/>
   <customStockMessage>Backordered:  Product will ship as soon as it becomes available.</customStockMessage>
</inventoryStatus>
			

Response Body Parameters

Fields
Data Type
Visibility
Description
availableQuantity
integer
default
The available quantity for product.
availableQuantityIsEstimated
Boolean
default
When true, the quantity is estimated.
customStockMessage
string
default
Custom message about stock availability. The Automatic Shipping Timeframe Messages feature must be enabled in Global Commerce to use this message.  For assistance enabling this feature, please contact your Digital River representative.  
expectedInStockDate
date
default
The date, YYYY-MM-DD, when the product is expected to be in stock.
inventoryStatus
structured
default
The inventory information for the product. 
Note: Inventory status is not available when requesting all products. 
product
link
default
The products in the category. See the Products API for more information.
productIsAllowsBackorders
Boolean
default
When true, the product allows back orders.
productIsInStock
Boolean
default
When true, the product is in stock.
productIsTracked
Boolean
default
When true, the product is tracked.
requestedQuantityAvailable
Boolean
default
When true, the requested quantity for the inventory is available.
status
string
default
The inventory status for the product.
statusIsEstimated
Boolean
default
When true, the status is estimated.