Retrieve the inventory status

Get the inventory status

To check a product's inventory status, provide its ID or external reference ID as a query parameter. If you provide an invalid ID, the system will ignore it. You will receive an empty collection with a 200 status if you do not provide any ID.

GEThttps://api.digitalriver.com/v1/shoppers/me/products/inventory-status

Query parameters

Response

200401

Successful response.

Body

application/json

productsobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/products/inventory-status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "products": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/inventory-status",
    "inventoryStatus": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/inventory-status",
        "product": [
          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500",
            "id": 64578500,
            "externalReferenceId": "Test External Reference Number",
            "companyId": "demosft1"
          }
        ],
        "availableQuantity": 2147483647,
        "availableQuantityIsEstimated": "false",
        "productIsInStock": "true",
        "productIsAllowsBackorders": "true",
        "productIsTracked": "false",
        "requestedQuantityAvailable": "true",
        "status": "PRODUCT_INVENTORY_IN_STOCK",
        "statusIsEstimated": "false",
        "expectedInStockDate": "text",
        "customStockMessage": "text"
      }
    ]
  }
}

Get the product's inventory status

To check the availability of a product or multiple products, provide the product ID or an external reference ID as a query parameter. If you provide an invalid ID, the system will ignore it. You will receive an empty collection with a 200 status if you don't provide any ID.

GEThttps://api.digitalriver.com/v1/shoppers/me/products/{productId}/inventory-status

Path parameters

productId*string

Provide the product identifier.

Query parameters

Response

200401

Successful response.

Body

application/json

inventoryStatusInventoryStatus (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/products/{productId}/inventory-status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "inventoryStatus": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/inventory-status",
    "product": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500",
        "id": 64578500,
        "externalReferenceId": "Test External Reference Number",
        "companyId": "demosft1"
      }
    ],
    "availableQuantity": 2147483647,
    "availableQuantityIsEstimated": "false",
    "productIsInStock": "true",
    "productIsAllowsBackorders": "true",
    "productIsTracked": "false",
    "requestedQuantityAvailable": "true",
    "status": "PRODUCT_INVENTORY_IN_STOCK",
    "statusIsEstimated": "false",
    "expectedInStockDate": "text",
    "customStockMessage": "text"
  }
}