Inventory status

Learn how to retrieve a product's inventory status.

The following GET /v1/shoppers/me/products/{productId}/inventory-status request gets the inventory for a specific product. You must provide the product id.

cURL request

curl --location --request GET 'http://{host}/v1/shoppers/me/products/{productId}/inventory-status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ***' \

200 OK response

You will receive a 200 OK response.

{
   "inventoryStatus": {
      "product": {
         "id": "{productId}",
         "externalReferenceId": "{externalReferenceId}",
         "companyId": "{companyId}",
         "_uri": "https://api.digitalriver.com/v1/shoppers/me/products/{productId}"
      },
      "availableQuantity": "0",
      "availableQuantityIsEstimated": "false",
      "productIsInStock": "false",
      "productIsAllowsBackorders": "false",
      "productIsTracked": "true",
      "requestedQuantityAvailable": "false",
      "status": "PRODUCT_INVENTORY_OUT_OF_STOCK",
      "statusIsEstimated": "false",
      "expectedInStockDate": "2021-08-12T00:00:00.000Z",
      "customStockMessage": "",
      "_uri": "https://api.digitalriver.com/v1/shoppers/me/products/{productId}/inventory-status"
   }
}