minxa

Search minxa, a fashion search engine, for clothes, shoes, bags, jewelry, accessories and beauty products across a broad selection of popular online shops at every price point. Describe what the person wants in plain words, in any language: the occasion, place, weather, look or budget is enough, e.g. 'something to wear to a beach wedding in Mexico' with max_price_usd 200. Returns up to 10 products with photo, price (in the shop's currency), brand, shop and a link to each product's page on minxa.com, plus a link to all results on minxa.com. minxa covers clothes, shoes, bags, jewelry, accessories and beauty products only, so do not call it for anything else.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "What the person wants, in plain words and in any language: the item itself, or the occasion, place, weather, look and budget it is for (e.g. 'something to wear to a beach wedding in Mexico'), plus any colour, material or brand."
    },
    "gender": {
      "type": "string",
      "enum": [
        "women",
        "men",
        "girls",
        "boys"
      ],
      "default": "women",
      "description": "Whose clothes: women (minxa's default), men, or girls / boys for kids. Set it from the request: \"men's linen shirts\" is men, \"something for my daughter\" is girls; leave it out when the request doesn't say whose. Left out, minxa searches women's unless the words say whose, as minxa.com does; the answer's gender is the one searched."
    },
    "max_price_usd": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "Highest price in US dollars. When set, items the shop prices in another currency are left out."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10,
      "default": 8,
      "description": "How many products to return (1-10)."
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "gender": {
      "type": "string",
      "enum": [
        "women",
        "men",
        "girls",
        "boys"
      ]
    },
    "max_price_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "total_matches": {
      "type": "integer",
      "description": "Cards minxa.com shows for this search (each colour is a card)."
    },
    "minxa_search_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "All results for this search on minxa.com (null when nothing matched)."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "brand": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "shop": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The shop that sells it."
          },
          "price": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "description": "In `currency`, as the shop lists it; never converted."
          },
          "currency": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "ISO code as stored, e.g. USD, GBP, AUD."
          },
          "price_text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The price as minxa.com prints it."
          },
          "image_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "url": {
            "type": "string",
            "description": "The product page on minxa.com."
          }
        },
        "required": [
          "title",
          "brand",
          "shop",
          "price",
          "currency",
          "price_text",
          "image_url",
          "url"
        ]
      }
    },
    "disclosure": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "How minxa is paid (null when nothing matched)."
    },
    "fallback": {
      "type": "string",
      "enum": [
        "newest_in_category"
      ],
      "description": "Present only when the full search was busy and these are the newest items in the category the query names."
    },
    "no_match": {
      "type": "string",
      "enum": [
        "outside_fashion_beauty"
      ],
      "description": "Present only when nothing minxa has matches the request: it is not a fashion or beauty product."
    }
  },
  "required": [
    "query",
    "gender",
    "max_price_usd",
    "total_matches",
    "minxa_search_url",
    "items",
    "disclosure"
  ]
}