Settings

GEThttps://rebuyengine.com/api/v1/smart-search/settings

Returns the complete Smart Search configuration for your shop, including global settings, keyword groups, search results settings, and quick view settings.

Headers¶

Rebuy-Api-Key · string: Your Rebuy public API key or My Shopify Domain

Query Parameters¶

key · string: Your Rebuy public API key (alternative to header)

Code Example¶

// GET https://rebuyengine.com/api/v1/smart-search/settings
fetch(`https://rebuyengine.com/api/v1/smart-search/settings?key=YOUR_API_KEY`)
  .then(response => response.json())
  .then(data => console.log(data));

Response Examples¶

200 OK¶

{
  "successful": true,
  "data": {
    "globalSettings": {
      "setting": {
        "settingsId": 18,
        "owner": 6410,
        "enabled": true,
        "renderOos": 0,
        "excludeOffensiveTerms": true,
        "searchResultsPageUrl": "/search",
        "excludedTerms": [
          { "id": 1, "term": "discontinued" }
        ],
        "excludedProductTags": [
          { "id": 1, "tag": "hidden" }
        ],
        "userDefinedCode": [
          {
            "id": 1,
            "body": ".rebuy-quick-view__container { background: #fff; }",
            "type": "css",
            "owner": 6410,
            "settingsId": 18
          }
        ],
        "excludedProducts": [],
        "excludedCollections": [],
        "searchInfluence": []
      }
    },
    "keywordSettings": {
      "setting": {
        "owner": 6410,
        "keywordGroups": [
          {
            "id": 36,
            "keywords": [
              { "id": 1, "keyword": "brew" },
              { "id": 2, "keyword": "coffee" }
            ],
            "redirectUrl": "/collections/coffee",
            "redirectEnabled": true,
            "keywordGroupName": "Coffee",
            "keywordInfluence": [],
            "promotedProducts": [],
            "showPromotedBadge": true,
            "promotedProductsAlwaysFirst": true
          },
          {
            "id": 37,
            "keywords": [
              { "id": 3, "keyword": "shirt" },
              { "id": 4, "keyword": "apparel" }
            ],
            "redirectUrl": "",
            "redirectEnabled": false,
            "keywordGroupName": "Apparel",
            "keywordInfluence": [],
            "promotedProducts": [],
            "showPromotedBadge": true,
            "promotedProductsAlwaysFirst": true
          }
        ]
      },
      "keywords": ["brew", "coffee", "shirt", "apparel"]
    },
    "searchResultsSettings": {
      "setting": {
        "settingsId": 8,
        "owner": 6410,
        "enabled": true,
        "embeddedSelector": "",
        "filterSettings": [
          {
            "id": 1,
            "key": "",
            "name": "Availability",
            "type": "availability",
            "index": 0,
            "enabled": true,
            "namespace": "default"
          },
          {
            "id": 2,
            "key": "",
            "name": "Price",
            "type": "price",
            "index": 1,
            "enabled": true,
            "namespace": "default"
          },
          {
            "id": 3,
            "key": "",
            "name": "Product Type",
            "type": "product-type",
            "index": 2,
            "enabled": true,
            "namespace": "default"
          }
        ],
        "sortSettings": [
          {
            "id": 1,
            "key": "featured",
            "name": "Featured",
            "index": 0,
            "enabled": true
          },
          {
            "id": 2,
            "key": "best-sellers",
            "name": "Best Sellers",
            "index": 1,
            "enabled": true
          },
          {
            "id": 3,
            "key": "lowest-price",
            "name": "Lowest Price",
            "index": 2,
            "enabled": true
          }
        ],
        "editorLayout": {
          "id": 9,
          "layout": "sidebar",
          "pageTitle": "Showing results for \"{term}\" ({count})",
          "layoutMode": "default",
          "soldOutTitle": "Sold Out",
          "addToCartTitle": "Add to Cart",
          "addToCartEnabled": true,
          "enabledProductRatings": true,
          "desktopColumnBreakpoint": 4
        }
      }
    },
    "quickViewSettings": {
      "setting": {
        "settingsId": 16,
        "owner": 6410,
        "enabled": true,
        "triggerSelector": "",
        "embeddedSelector": "",
        "suggestedSearchTerms": ["Coffee", "Tea", "Apparel"],
        "suggestedProducts": [
          {
            "id": "7432474001641",
            "name": "Sample Product",
            "price": 1999,
            "url": "/products/sample-product",
            "images": [{ "url": "https://cdn.shopify.com/..." }],
            "variants": [
              {
                "id": "43348965818601",
                "name": "Default",
                "price": 1999,
                "canPurchase": true
              }
            ]
          }
        ],
        "suggestedCollections": [
          {
            "id": 34,
            "name": "Apparel",
            "handle": "apparel",
            "enabled": true
          }
        ],
        "editorLayout": {
          "id": 8,
          "layout": "dropdown",
          "matchingProductsEnabled": true,
          "suggestedProductsEnabled": true,
          "suggestedCollectionsEnabled": true,
          "suggestedSearchTermsEnabled": true
        }
      }
    }
  },
  "status": 200,
  "errorMessage": null
}

Response Structure

The response includes all Smart Search settings for your shop. The example above is simplified - actual responses include additional fields and complete product/variant data.

400 Bad Request¶

{
  "successful": false,
  "message": "Shop combined settings could not be found.",
  "errors": [{ "message": "Unable to find." }]
}

401 Unauthorized¶

{
  "status": false,
  "errorCode": "no-api-key",
  "errors": ["An API key or My Shopify Domain must be provided via a header Rebuy-Api-Key or using the GET variable \"?key=\"."]
}

See something that needs updating? Suggest an edit