Inventory status

Get the inventory status

get

To check a product's inventory status, provide its ID or external reference ID as the {id}. 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.

Query parameters

apiKeystringOptional

Provide your client identifier.

tokenstringOptional

Provide the authorized or anonymous token for a shopper.

expandstringOptional

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstringOptional

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

companyIdstringOptional

Provide the identifier for the company that owns the product. If you do not provide the companyId, the call will use the default company associated with the API key.

externalReferenceIdstringOptional

Provide the external reference identifier for your product. The externalReferenceId is your company's internal identifier or stock keeping unit (SKU) for a product.

productIdstringOptional

Provide a comma separated-list of identifiers of one or more products to include in the response.

Responses

200

Successful response.

application/json

401

* Invalid Token

application/json

get

HTTPcURLJavaScriptPython

GET /v1/shoppers/me/products/inventory-status HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "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 inventory status of a product

get

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.

Path parameters

productIdstringRequired

Provide the product identifier.

Query parameters

apiKeystringOptional

Provide your client identifier.

tokenstringOptional

Provide the authorized or anonymous token for a shopper.

expandstringOptional

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstringOptional

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Responses

200

Successful response.

application/json

401

* Invalid Token

application/json

get

HTTPcURLJavaScriptPython

GET /v1/shoppers/me/products/{productId}/inventory-status HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "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"
  }
}