SearchResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aislesinventory-com/json-schema/aislesinventory-com-search-result-schema.json",
  "title": "SearchResult",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aislesinventory-com-openapi.json#/components/schemas/SearchResult",
  "type": "object",
  "required": [
    "pagination",
    "results"
  ],
  "properties": {
    "api_version": {
      "type": "string"
    },
    "sandbox": {
      "type": "boolean",
      "description": "true on sandbox (synthetic) data"
    },
    "pagination": {
      "$ref": "#/$defs/Pagination"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Listing"
      }
    }
  },
  "$defs": {
    "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."
        }
      }
    }
  }
}