Skip to main content
GET
/
api
/
product
/
inventory
/
list
List Products
curl --request GET \
  --url https://api.example.com/api/product/inventory/list
{
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "category": "<string>",
      "barcode": "<string>",
      "nutrition": {
        "energy_kcal": "<string>",
        "carbohydrate": "<string>",
        "protein": "<string>",
        "fiber": "<string>",
        "total_sugars": "<string>",
        "saturated_fat": "<string>",
        "vitamin_a": "<string>",
        "vitamin_c": "<string>",
        "potassium": "<string>",
        "iron": "<string>",
        "calcium": "<string>",
        "sodium": "<string>",
        "cholesterol": "<string>"
      }
    }
  ]
}

Endpoint

GET /api/product/inventory/list
This endpoint retrieves a list of all products in the inventory database. You can optionally filter the results by product name.

Query Parameters

name
string
Filter products by name. Returns products that match the provided name.

Response

The endpoint returns a list of products with their details including nutrition information if available.
products
array
Array of product objects
id
string
Unique identifier of the product
name
string
Name of the product
category
string
Category of the product
barcode
string
Barcode identifier for the product
nutrition
object
Nutrition information for the product
energy_kcal
string
Energy content in kilocalories
carbohydrate
string
Carbohydrate content
protein
string
Protein content
fiber
string
Fiber content
total_sugars
string
Total sugar content
saturated_fat
string
Saturated fat content
vitamin_a
string
Vitamin A content
vitamin_c
string
Vitamin C content
potassium
string
Potassium content
iron
string
Iron content
calcium
string
Calcium content
sodium
string
Sodium content
cholesterol
string
Cholesterol content

Example Request

# Get all products
curl -X GET https://api.expireeye.com/api/product/inventory/list

# Filter products by name
curl -X GET "https://api.expireeye.com/api/product/inventory/list?name=Milk"

Example Response

{
  "products": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Organic Milk",
      "category": "Dairy",
      "barcode": "123456789012",
      "nutrition": {
        "energy_kcal": "150",
        "carbohydrate": "12g",
        "protein": "8g",
        "fiber": "0g",
        "total_sugars": "12g",
        "saturated_fat": "5g",
        "vitamin_a": "10%",
        "vitamin_c": "0%",
        "potassium": "350mg",
        "iron": "0mg",
        "calcium": "300mg",
        "sodium": "120mg",
        "cholesterol": "20mg"
      }
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Whole Wheat Bread",
      "category": "Bakery",
      "barcode": "987654321098",
      "nutrition": null
    }
  ]
}

Build docs developers (and LLMs) love