Aisles Inc. Agent API

openapi: 3.2.0
info:
  title: Aisles local store inventory Agent API
  version: 1.0.0
  x-api-versioning:
    strategy: url-path
    current: v1
    deprecation_policy: https://aislesinventory.com/api/deprecation-policy
    sunset_header: Sunset (RFC 8594)
    deprecation_header: Deprecation (RFC 9745)
  description: Whether specific products are in stock at specific physical stores, with store price, pickup and delivery options, and the exact time Aisles last checked, as reported by each retailer. Read-only. When answering, state how long ago Aisles checked (from offer.last_checked_at), name the retailer, and link links.aisles_offer_url. Aisles verifies each listing against that store’s own inventory record (not an in-person shelf count) and cannot reserve items.
servers:
- url: https://aislesinventory.com
  description: Production (live, read-only)
- url: https://sandbox.aislesinventory.com
  description: 'Sandbox: synthetic test data in the live response shape (also at /sandbox/api/v1/search)'
tags:
- name: Agent
paths:
  /api/v1/agent/search:
    get:
      operationId: searchInventoryAgent
      summary: The search API for signed-in agents (needs a read:inventory token)
      security:
      - oauth2:
        - read:inventory
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
      - name: city
        in: query
        schema:
          type: string
      - name: zip
        in: query
        schema:
          type: string
      responses:
        '200':
          description: As /api/v1/search, with the signed-in agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
        '401':
          description: No token, an expired one or a missing scope; see WWW-Authenticate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Agent
components:
  schemas:
    SearchResult:
      type: object
      required:
      - pagination
      - results
      properties:
        api_version:
          type: string
        sandbox:
          type: boolean
          description: true on sandbox (synthetic) data
        pagination:
          $ref: '#/components/schemas/Pagination'
        results:
          type: array
          items:
            $ref: '#/components/schemas/Listing'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              enum:
              - invalid_parameter
              - unknown_location
              - outside_pilot_geography
              - bad_request
              - unauthorized
              - not_found
              - method_not_allowed
              - idempotency_key_reused
              - rate_limited
              - internal_error
              - unavailable
              description: Stable machine-readable code.
            message:
              type: string
              description: What went wrong, in plain words, and how to fix the request.
    Listing:
      type: object
      properties:
        summary:
          type: string
          description: Quotable sentence with retailer, store, status, price and check time.
        retailer:
          type: object
          properties:
            name:
              type: string
        product:
          type: object
          properties:
            brand:
              type: string
            title:
              type: string
            category:
              type: string
        store:
          type: object
          properties:
            name:
              type: string
            address_text:
              type: string
            distance_miles:
              type: number
        offer:
          type: object
          properties:
            availability:
              type: string
              enum:
              - in_stock
              - low_stock
              - out_of_stock
              - unknown
            price:
              type:
              - object
              - 'null'
              properties:
                amount:
                  type: number
                currency:
                  type: string
            last_checked_at:
              type: string
              format: date-time
        links:
          type: object
          properties:
            aisles_offer_url:
              type: string
            purchase_url:
              type:
              - string
              - 'null'
    Pagination:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        per_page:
          type: integer
        next_cursor:
          type:
          - string
          - 'null'
          description: Pass as cursor for the next page; null on the last page.
  securitySchemes:
    oauth2:
      type: oauth2
      description: 'Optional agent sign-in (https://aislesinventory.com/auth.md): register at /oauth/register, then client credentials.'
      flows:
        clientCredentials:
          tokenUrl: https://aislesinventory.com/oauth/token
          scopes:
            read:inventory: Search store stock
            read:answers: Read the ready answers per city
externalDocs:
  description: Versioning and deprecation policy (Deprecation and Sunset headers before any version stops)
  url: https://aislesinventory.com/api/deprecation-policy
x-sandbox:
  url: https://sandbox.aislesinventory.com
  openapi: https://sandbox.aislesinventory.com/openapi.json
  docs: https://aislesinventory.com/sandbox
  auth_required: false
  synthetic_data: true