Skip to content

Active Settings

Query Parameters

handle · string · Default: throw-blankets
URL-friendly identifier for the collection provided by Shopify
Rebuy-Api-Key · string · Default: 5da0da1d35e8a47b16bea7c6112c7f1d2ca867d6
Your Rebuy public API key or My Shopify Domain
key · string · Default: 5da0da1d35e8a47b16bea7c6112c7f1d2ca867d6
Your Rebuy public API key or My Shopify Domain

Code Example

// GET https://rebuyengine.com/api/v1/smart-collections/{handle}/setting
const params = new URLSearchParams({
  handle: "YOUR_VALUE",
  Rebuy-Api-Key: "YOUR_VALUE"
});

fetch(`https://rebuyengine.com/api/v1/smart-collections/{handle}/setting?${params}`)
  .then(response => response.json())
  .then(data => console.log(data));

Response Examples

200 - 200

{
    "successful": true,
    "data": {
        "shopId": 30210,
        "collectionId": 487577813288,
        "settingType": "collection",
        "settingId": 5,
        "enabled": true,
        "featuredProducts": [
            {
                "id": 50,
                "owner": 30210,
                "productId": 9530567786792,
                "settingsId": 5,
                "collectionId": 487577813288
            }
        ],
        "promoTiles": [
            {
                "id": 8,
                "name": "New Arrivals",
                "owner": 30210,
                "content": {
                    "image": true,
                    "imageUrl": "https://imagedelivery.net/rG-6Kka_dHhejlGfRC089g/30210/gallery/bc5b55f1-0274-46e9-8bec-5243de9956c6.jpg/public",
                    "imageUuid": "bc5b55f1-0274-46e9-8bec-5243de9956c6",
                    "imageRedirectUrl": ""
                },
                "placement": {
                    "page": "firstPage",
                    "position": 1
                },
                "settingsId": 5,
                "collectionId": 487577813288
            }
        ],
        "renderOos": 1,
        "filters": [
            {
                "id": 11,
                "key": "",
                "name": "Availability",
                "type": "availability",
                "index": 0,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 12,
                "key": "",
                "name": "Product Type",
                "type": "product-type",
                "index": 1,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 13,
                "key": "",
                "name": "Price",
                "type": "price",
                "index": 2,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 14,
                "key": "",
                "name": "Product Tags",
                "type": "product-tags",
                "index": 3,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 15,
                "key": "",
                "name": "Vendor",
                "type": "vendor",
                "index": 4,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            }
        ],
        "sortOptions": [
            {
                "id": 21,
                "key": "featured",
                "name": "Featured",
                "index": 0,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 22,
                "key": "best-sellers",
                "name": "Best Sellers",
                "index": 1,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 7
            },
            {
                "id": 23,
                "key": "highest-price",
                "name": "Highest Price",
                "index": 2,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 24,
                "key": "lowest-price",
                "name": "Lowest Price",
                "index": 3,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 25,
                "key": "new-arrivals",
                "name": "New Arrivals",
                "index": 4,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 26,
                "key": "highest-rating",
                "name": "Highest Rating",
                "index": 5,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 27,
                "key": "lowest-rating",
                "name": "Lowest Rating",
                "index": 6,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 28,
                "key": "oldest",
                "name": "Oldest",
                "index": 7,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 29,
                "key": "name-ascending",
                "name": "Name (A-Z)",
                "index": 8,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 30,
                "key": "name-descending",
                "name": "Name (Z-A)",
                "index": 9,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            }
        ],
        "collectionData": {
            "createdAt": 1742390983,
            "description": "",
            "descriptionText": "",
            "handle": "new-arrivals",
            "id": "487577813288",
            "images": [],
            "name": "New Arrivals",
            "productIds": [
                "9530531873064",
                "9530531741992",
                "9530533413160",
                "9530530922792",
                "9530533216552",
                "9530533282088",
                "9530531545384",
                "9530532036904",
                "9530531971368",
                "9530567786792",
                "9530566934824",
                "9530566803752",
                "9530566639912",
                "9530566476072",
                "9530565755176",
                "9530558087464",
                "9530557858088",
                "9530557759784",
                "9530549469480",
                "9530546520360",
                "9530545668392",
                "9530545635624",
                "9530545209640",
                "9530544619816",
                "9530542719272",
                "9530542358824",
                "9530542031144",
                "9530540982568",
                "9530540687656",
                "9530539999528",
                "9530539868456",
                "9530539475240",
                "9530538950952",
                "9530538852648",
                "9530538623272",
                "9530538524968",
                "9530538295592",
                "9530537804072",
                "9530537607464",
                "9530534297896"
            ],
            "updatedAt": 1742390983,
            "visible": true
        },
        "template": {
            "layout": "sidebar",
            "pageTitle": "Showing results for \"{term}\" ({count})",
            "pagination": {
                "type": "default",
                "limitOptions": [
                    15,
                    25,
                    75
                ],
                "loadMoreText": "Load More Products",
                "amountPerPage": 15
            },
            "soldOutTitle": "Sold Out",
            "addToCartTitle": "Add to Cart",
            "addToCartEnabled": false,
            "addedToCartTitle": "Added",
            "addingToCartTitle": "Adding",
            "enabledProductRatings": true,
            "mobileColumnBreakpoint": 1,
            "tabletColumnBreakpoint": 2,
            "desktopColumnBreakpoint": 4,
            "searchBarPlaceHolderText": "Search for products"
        },
        "tagFilters": [],
        "tagExclusions": []
    },
    "status": 200,
    "errorMessage": null,
    "metadata": []
}{
    "successful": true,
    "data": {
        "shopId": 30210,
        "collectionId": 487577813288,
        "settingType": "collection",
        "settingId": 5,
        "enabled": true,
        "featuredProducts": [
            {
                "id": 50,
                "owner": 30210,
                "productId": 9530567786792,
                "settingsId": 5,
                "collectionId": 487577813288
            }
        ],
        "promoTiles": [
            {
                "id": 8,
                "name": "New Arrivals",
                "owner": 30210,
                "content": {
                    "image": true,
                    "imageUrl": "https://imagedelivery.net/rG-6Kka_dHhejlGfRC089g/30210/gallery/bc5b55f1-0274-46e9-8bec-5243de9956c6.jpg/public",
                    "imageUuid": "bc5b55f1-0274-46e9-8bec-5243de9956c6",
                    "imageRedirectUrl": ""
                },
                "placement": {
                    "page": "firstPage",
                    "position": 1
                },
                "settingsId": 5,
                "collectionId": 487577813288
            }
        ],
        "renderOos": 1,
        "filters": [
            {
                "id": 11,
                "key": "",
                "name": "Availability",
                "type": "availability",
                "index": 0,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 12,
                "key": "",
                "name": "Product Type",
                "type": "product-type",
                "index": 1,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 13,
                "key": "",
                "name": "Price",
                "type": "price",
                "index": 2,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 14,
                "key": "",
                "name": "Product Tags",
                "type": "product-tags",
                "index": 3,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            },
            {
                "id": 15,
                "key": "",
                "name": "Vendor",
                "type": "vendor",
                "index": 4,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "namespace": "default",
                "settingsId": 3,
                "excludeSpecific": false
            }
        ],
        "sortOptions": [
            {
                "id": 21,
                "key": "featured",
                "name": "Featured",
                "index": 0,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 22,
                "key": "best-sellers",
                "name": "Best Sellers",
                "index": 1,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 7
            },
            {
                "id": 23,
                "key": "highest-price",
                "name": "Highest Price",
                "index": 2,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 24,
                "key": "lowest-price",
                "name": "Lowest Price",
                "index": 3,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 25,
                "key": "new-arrivals",
                "name": "New Arrivals",
                "index": 4,
                "label": "",
                "owner": 30210,
                "enabled": true,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 26,
                "key": "highest-rating",
                "name": "Highest Rating",
                "index": 5,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 27,
                "key": "lowest-rating",
                "name": "Lowest Rating",
                "index": 6,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 28,
                "key": "oldest",
                "name": "Oldest",
                "index": 7,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 29,
                "key": "name-ascending",
                "name": "Name (A-Z)",
                "index": 8,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            },
            {
                "id": 30,
                "key": "name-descending",
                "name": "Name (Z-A)",
                "index": 9,
                "label": "",
                "owner": 30210,
                "enabled": false,
                "settingsId": 3,
                "lookbackType": "default",
                "lookbackPeriod": 0
            }
        ],
        "collectionData": {
            "createdAt": 1742390983,
            "description": "",
            "descriptionText": "",
            "handle": "new-arrivals",
            "id": "487577813288",
            "images": [],
            "name": "New Arrivals",
            "productIds": [
                "9530531873064",
                "9530531741992",
                "9530533413160",
                "9530530922792",
                "9530533216552",
                "9530533282088",
                "9530531545384",
                "9530532036904",
                "9530531971368",
                "9530567786792",
                "9530566934824",
                "9530566803752",
                "9530566639912",
                "9530566476072",
                "9530565755176",
                "9530558087464",
                "9530557858088",
                "9530557759784",
                "9530549469480",
                "9530546520360",
                "9530545668392",
                "9530545635624",
                "9530545209640",
                "9530544619816",
                "9530542719272",
                "9530542358824",
                "9530542031144",
                "9530540982568",
                "9530540687656",
                "9530539999528",
                "9530539868456",
                "9530539475240",
                "9530538950952",
                "9530538852648",
                "9530538623272",
                "9530538524968",
                "9530538295592",
                "9530537804072",
                "9530537607464",
                "9530534297896"
            ],
            "updatedAt": 1742390983,
            "visible": true
        },
        "template": {
            "layout": "sidebar",
            "pageTitle": "Showing results for \"{term}\" ({count})",
            "pagination": {
                "type": "default",
                "limitOptions": [
                    15,
                    25,
                    75
                ],
                "loadMoreText": "Load More Products",
                "amountPerPage": 15
            },
            "soldOutTitle": "Sold Out",
            "addToCartTitle": "Add to Cart",
            "addToCartEnabled": false,
            "addedToCartTitle": "Added",
            "addingToCartTitle": "Adding",
            "enabledProductRatings": true,
            "mobileColumnBreakpoint": 1,
            "tabletColumnBreakpoint": 2,
            "desktopColumnBreakpoint": 4,
            "searchBarPlaceHolderText": "Search for products"
        },
        "tagFilters": [],
        "tagExclusions": []
    },
    "status": 200,
    "errorMessage": null,
    "metadata": []
}

404 - 404

{
  "successful": false,
  "message": "Collection not found",
  "errors": [
    {
      "message": "invalid handle"
    }
  ]
}