mach-five-group.github.io

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 200,
      "description": "Free text matched against name, description, SKU, brand and category"
    },
    "category": {
      "type": "string",
      "description": "Exact category",
      "enum": [
        "Accessories",
        "Apparel"
      ]
    },
    "brand": {
      "type": "string",
      "description": "Exact brand",
      "enum": [
        "Mach Five Tech"
      ]
    },
    "availability": {
      "type": "string",
      "description": "Stock status",
      "enum": [
        "InStock",
        "OutOfStock"
      ]
    },
    "maxPrice": {
      "type": "number",
      "minimum": 0,
      "description": "Only products at or below this price"
    },
    "minPrice": {
      "type": "number",
      "minimum": 0,
      "description": "Only products at or above this price"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 10,
      "description": "Maximum results (default 10, max 50)"
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0,
      "description": "Skip this many matches, for paging"
    }
  }
}