Aisles Inc. Jobs API

openapi: 3.2.0
info:
  title: Aisles local store inventory Jobs 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: Jobs
paths:
  /api/v1/jobs:
    post:
      operationId: createSearchJob
      summary: Run a batch search in the background
      parameters:
      - name: Idempotency-Key
        in: header
        schema:
          type: string
          maxLength: 200
        description: 'Optional. A retry with the same key and body within 24 hours gets the first response again (Idempotent-Replayed: true).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - queries
              properties:
                queries:
                  type: array
                  minItems: 1
                  maxItems: 10
                  items:
                    type: object
                    required:
                    - q
                    properties:
                      q:
                        type: string
                      city:
                        type: string
                      zip:
                        type: string
                      availability:
                        type: string
                      per_page:
                        type: integer
      responses:
        '202':
          description: Accepted; poll status_url (also in Location).
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_id:
                    type: string
                  id:
                    type: string
                  status:
                    type: string
                    enum:
                    - queued
                    - running
                    - succeeded
                    - failed
                  status_url:
                    type: string
                  result:
                    type: object
        '400':
          description: No searches, or more than 10.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Jobs
  /api/v1/jobs/{id}:
    get:
      operationId: getSearchJob
      summary: A job's status, and its results once it has succeeded
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_id:
                    type: string
                  id:
                    type: string
                  status:
                    type: string
                    enum:
                    - queued
                    - running
                    - succeeded
                    - failed
                  status_url:
                    type: string
                  result:
                    type: object
        '404':
          description: No such job (kept for an hour).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Jobs
components:
  schemas:
    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.
  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