> ## Documentation Index
> Fetch the complete documentation index at: https://docs.switchyard.run/llms.txt
> Use this file to discover all available pages before exploring further.

# List products with availability

> Returns paginated list of products with availability scores and stats.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/availability
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/availability:
    get:
      tags:
        - Availability
      summary: List products with availability
      description: Returns paginated list of products with availability scores and stats.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
          required: false
          name: offset
          in: query
        - schema:
            type: string
            enum:
              - high
              - medium
              - low
              - unavailable
              - unknown
          required: false
          name: tier
          in: query
        - schema:
            type: string
            enum:
              - high
              - medium
              - low
          required: false
          name: confidence
          in: query
        - schema:
            type: string
          required: false
          name: is_rfc_item
          in: query
        - schema:
            type: string
            maxLength: 200
          required: false
          name: search
          in: query
        - schema:
            type: string
            enum:
              - availability_score
              - demand_velocity_7d
              - name
            default: availability_score
          required: false
          name: sort
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
          required: false
          name: order
          in: query
      responses:
        '200':
          description: List of products with availability data
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        brand:
                          type: string
                          nullable: true
                        image_url:
                          type: string
                          nullable: true
                        selling_price:
                          type: number
                          nullable: true
                        is_rfc_item:
                          type: boolean
                        availability_score:
                          type: number
                          nullable: true
                        availability_tier:
                          type: string
                          nullable: true
                        availability_score_updated_at:
                          type: string
                          nullable: true
                        confidence:
                          type: object
                          properties:
                            level:
                              type: string
                            lower:
                              type: number
                              nullable: true
                            upper:
                              type: number
                              nullable: true
                          required:
                            - level
                            - lower
                            - upper
                        demand_velocity_7d:
                          type: number
                          nullable: true
                        demand_velocity_updated_at:
                          type: string
                          nullable: true
                        target_stock_days:
                          type: number
                          nullable: true
                        reorder_point_days:
                          type: number
                          nullable: true
                        max_restock_per_sweep:
                          type: number
                          nullable: true
                        preferred_retailer:
                          type: string
                          nullable: true
                        scraped_product_id:
                          type: string
                          nullable: true
                          format: uuid
                        category:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                          required:
                            - id
                            - name
                      required:
                        - id
                        - name
                        - brand
                        - image_url
                        - selling_price
                        - is_rfc_item
                        - availability_score
                        - availability_tier
                        - availability_score_updated_at
                        - confidence
                        - demand_velocity_7d
                        - demand_velocity_updated_at
                        - target_stock_days
                        - reorder_point_days
                        - max_restock_per_sweep
                        - preferred_retailer
                        - scraped_product_id
                        - category
                  count:
                    type: number
                  offset:
                    type: number
                  limit:
                    type: number
                  stats:
                    type: object
                    properties:
                      total:
                        type: number
                      by_tier:
                        type: object
                        properties:
                          high:
                            type: number
                          medium:
                            type: number
                          low:
                            type: number
                          unavailable:
                            type: number
                          unknown:
                            type: number
                        required:
                          - high
                          - medium
                          - low
                          - unavailable
                          - unknown
                      by_confidence:
                        type: object
                        properties:
                          high:
                            type: number
                          medium:
                            type: number
                          low:
                            type: number
                        required:
                          - high
                          - medium
                          - low
                    required:
                      - total
                      - by_tier
                      - by_confidence
                required:
                  - products
                  - count
                  - offset
                  - limit
                  - stats

````