List Inventory

GET 
/products/inventory

The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.

Request

Version stringrequired

API Version

Available options2021-07-28

limit number

The maximum number of items to be included in a single page of results

Default value:0

offset number

The starting index of the page, indicating the position from which the results should be retrieved.

Default value:0

altId stringrequired

Location Id or Agency Id

altType stringrequired

Available optionslocation

search string

Search string for Variant Search

application/json

Successful response

application/json

Schema

Schema

inventoryobject[]required

List of inventory items

totalobjectrequired

Total count of inventory items

Example (auto)

{
  "inventory": [
    {
      "_id": "6241712be68f7a98102ba272",
      "name": "Medium T-shirt",
      "availableQuantity": 50,
      "sku": "TSHIRT-MED-001",
      "allowOutOfStockPurchases": false,
      "product": "6241712be68f7a98102ba270",
      "updatedAt": "2023-12-12T09:27:42.355Z",
      "image": "https://example.com/images/product.jpg",
      "productName": "T-shirt"
    }
  ],
  "total": {
    "total": 100
  }
}