Skip to main content
GET
/
v1
/
availability
List products with availability
curl --request GET \
  --url http://localhost:3000/v1/availability
{
  "products": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "selling_price": 123,
      "is_rfc_item": true,
      "availability_score": 123,
      "availability_tier": "<string>",
      "availability_score_updated_at": "<string>",
      "confidence": {
        "level": "<string>",
        "lower": 123,
        "upper": 123
      },
      "demand_velocity_7d": 123,
      "demand_velocity_updated_at": "<string>",
      "target_stock_days": 123,
      "reorder_point_days": 123,
      "max_restock_per_sweep": 123,
      "preferred_retailer": "<string>",
      "scraped_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123,
  "stats": {
    "total": 123,
    "by_tier": {
      "high": 123,
      "medium": 123,
      "low": 123,
      "unavailable": 123,
      "unknown": 123
    },
    "by_confidence": {
      "high": 123,
      "medium": 123,
      "low": 123
    }
  }
}

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0
tier
enum<string>
Available options:
high,
medium,
low,
unavailable,
unknown
confidence
enum<string>
Available options:
high,
medium,
low
is_rfc_item
string
Maximum string length: 200
sort
enum<string>
default:availability_score
Available options:
availability_score,
demand_velocity_7d,
name
order
enum<string>
default:asc
Available options:
asc,
desc

Response

200 - application/json

List of products with availability data

products
object[]
required
count
number
required
offset
number
required
limit
number
required
stats
object
required