Skip to main content
The /v1/availability endpoint checks whether a specific product is currently available at a farm.
GET https://api.bhumifarms.co/v1/availability

Parameters

farm_id
string
required
The farm’s unique identifier (UUID).
product
string
required
The product name to check. Case-insensitive match.

Example request

curl "https://api.bhumifarms.co/v1/availability?farm_id=abc123-def456&product=raw%20milk" \
  -H "X-API-Key: bh_live_your_key_here"

Example response

{
  "data": {
    "farm_id": "abc123-def456",
    "farm_name": "Rolling Meadow Dairy",
    "product": "raw milk",
    "listed": true,
    "in_stock": true,
    "listing": {
      "id": "prod_042",
      "name": "Raw Milk",
      "price": 12.00,
      "unit": "gallon"
    }
  }
}

Response fields

farm_id
string
The farm’s unique identifier.
farm_name
string
The farm’s display name.
product
string
The product name that was queried.
listed
boolean
Whether the farm lists this product in their profile. true means the farm carries this product.
in_stock
boolean | null
Current stock status. true = in stock, false = out of stock, null = stock status not tracked for this product.
listing
object | null
Structured product listing if available. Includes id, name, price, and unit. Returns null if the farm has no structured listing for this product.
listed: true with in_stock: null means the farm carries this product but does not actively track stock status through Bhumi. Contact the farm directly for real-time availability.