storefront

Free-text search across product name + description

get/api/v1/storefront/search

Request

Base URL: https://api.foundryims.com (the document declares no server; this is the origin it was published from)
URL: https://api.foundryims.com/api/v1/storefront/search
Auth: HTTP bearer

Query parameters

qstring

Free-text term (required): product name/description and listed-variant identifiers.

pagenumber

limitnumber

Response

Example response

{
  "data": [
    {
      "slug": "anti-gravity-boots",
      "metaTitle": "Anti-Gravity Boots | Acme",
      "metaDescription": "Float through your day with our best-selling anti-gravity boots.",
      "priceFrom": 19.99,
      "compareAtPriceFrom": 24.99,
      "currency": "USD",
      "availableQuantity": 14,
      "variantCount": 3,
      "customFields": [
        {
          "key": "cooling_capacity",
          "label": "Cooling Capacity",
          "unit": "BTU/h",
          "type": "number",
          "group": "Performance",
          "displayOrder": 10
        }
      ],
      "variants": [
        {
          "price": 19.99,
          "regularPrice": 24.99,
          "compareAtPrice": 24.99,
          "availableQuantity": 14,
          "optionValues": [
            {
              "name": "Color",
              "value": "Red"
            }
          ],
          "images": [
            {
              "url": "https://cdn.example.com/img/abc.jpg"
            }
          ],
          "customFields": [
            {
              "key": "cooling_capacity",
              "label": "Cooling Capacity",
              "unit": "BTU/h",
              "type": "number",
              "group": "Performance",
              "displayOrder": 10
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 137,
    "totalPages": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.