Alve API Access Application no longer accepts requests.

Search Edit the file on GitHub

Table of Contents
  GET /search
Name Type Description
q String Search with the value of this parameter

The main response type is a collection of Categories.

There may be alternate suggestion queries provided in the alternatives key of the meta object.

Any of those alternatives with the flag important set to true, are a hint for the client to perform a search with the alternative query instead.

There may also exist matches of different resources under the key strong_matches.

Currently there may be up-to one of each of the following resources in strong_matches:

Query with less than 2 characters

GET https://api.alve.com/search?q=a

View Response
Show Headers
Status: 422
{
  "errors": [
    {
      "code": "InvalidSearch",
      "messages": [
        "Aramanız en az 2 karakter içermelidir"
      ]
    }
  ]
}

Query that doesn't match anything

GET https://api.alve.com/search?q=asdf

View Response
Show Headers
Status: 200
{
  "categories": [

  ],
  "meta": {
    "q": "asdf",
    "alternatives": [

    ],
    "strong_matches": {
    }
  }
}

Query with more results when written in another language

GET https://api.alve.com/search?q=%CE%BD%CF%84%CE%BF%CE%BB%CE%BC%CE%B1

View Response Params
{
  "page": 1,
  "per": 2
}
Show Headers
Status: 200
{
  "categories": [

  ],
  "meta": {
    "q": "ντολμα",
    "alternatives": [

    ],
    "strong_matches": {
    }
  }
}

Probably misspelled query

GET https://api.alve.com/search?q=ipone

View Response Params
{
  "page": 1,
  "per": 2
}
Show Headers
Status: 200
{
  "categories": [
    {
      "id": 518,
      "name": "Fiş - Adaptör",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/518/518.jpg",
      "parent_id": 512,
      "fashion": false,
      "layout_mode": "list",
      "web_uri": "https://www.alve.com/c/518/fis-adaptor.html",
      "code": "fis_adaptorler",
      "path": "1,2,512,518",
      "show_specifications": false,
      "manufacturer_title": "Markalar",
      "match_count": 4
    },
    {
      "id": 34,
      "name": "Cep Telefonu Kılıfı",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/34/34.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/34/cep-telefonu-kilifi.html",
      "code": "cep-telefonu-kiliflari",
      "path": "1,2,12,32,34",
      "show_specifications": false,
      "manufacturer_title": "Markalar",
      "match_count": 2
    }
  ],
  "meta": {
    "q": "ipone",
    "alternatives": [

    ],
    "strong_matches": {
    },
    "pagination": {
      "total_results": 3,
      "total_pages": 2,
      "page": 1,
      "per": 2
    }
  }
}

Query matching many categories

GET https://api.alve.com/search?q=iphone

View Response Params
{
  "page": 1,
  "per": 2
}
Show Headers
Status: 200
{
  "categories": [
    {
      "id": 33,
      "name": "Cep Telefonu",
      "children_count": 0,
      "image_url": "https://alve-b.scdn.gr/ds/categories/33/20150622142746_9efad8e8.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "list",
      "web_uri": "https://www.alve.com/c/33/cep-telefonu.html",
      "code": "mobile",
      "path": "1,2,12,32,33",
      "show_specifications": true,
      "manufacturer_title": "Markalar",
      "match_count": 19
    },
    {
      "id": 34,
      "name": "Cep Telefonu Kılıfı",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/34/34.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/34/cep-telefonu-kilifi.html",
      "code": "cep-telefonu-kiliflari",
      "path": "1,2,12,32,34",
      "show_specifications": false,
      "manufacturer_title": "Markalar",
      "match_count": 22077
    }
  ],
  "meta": {
    "q": "iphone",
    "alternatives": [

    ],
    "strong_matches": {
    },
    "pagination": {
      "total_results": 33,
      "total_pages": 17,
      "page": 1,
      "per": 2
    }
  }
}

Query with strong hints for a specific category match

GET https://api.alve.com/search?q=Tablets

View Response Params
{
  "page": 1,
  "per": 2
}
Show Headers
Status: 200
{
  "categories": [
    {
      "id": 19,
      "name": "Tablet",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/19/20150622142809_2e78d8bc.jpg",
      "parent_id": 9,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/19/tablet.html",
      "code": "tablet",
      "path": "1,2,8,9,19",
      "show_specifications": true,
      "manufacturer_title": "Markalar",
      "match_count": 343
    },
    {
      "id": 297,
      "name": "Beslenme",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/297/297.jpg",
      "parent_id": 790,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/297/beslenme_ilaclar.html",
      "code": "beslenme_ilaclar",
      "path": "1,790,297",
      "show_specifications": false,
      "manufacturer_title": "Markalar",
      "match_count": 2
    }
  ],
  "meta": {
    "q": "Tablets",
    "alternatives": [

    ],
    "strong_matches": {
      "category": {
        "id": 19,
        "name": "Tablet",
        "children_count": 0,
        "image_url": "https://alve-d.scdn.gr/ds/categories/19/20150622142809_2e78d8bc.jpg",
        "parent_id": 9,
        "fashion": false,
        "layout_mode": "tiles",
        "web_uri": "https://www.alve.com/c/19/tablet.html",
        "code": "tablet",
        "path": "1,2,8,9,19",
        "show_specifications": true,
        "manufacturer_title": "Markalar"
      }
    },
    "pagination": {
      "total_results": 4,
      "total_pages": 2,
      "page": 1,
      "per": 2
    }
  }
}

Query with strong hints for a specific manufacturer match

GET https://api.alve.com/search?q=apple

View Response Params
{
  "page": 1,
  "per": 5
}
Show Headers
Status: 200
{
  "categories": [
    {
      "id": 33,
      "name": "Cep Telefonu",
      "children_count": 0,
      "image_url": "https://alve-b.scdn.gr/ds/categories/33/20150622142746_9efad8e8.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "list",
      "web_uri": "https://www.alve.com/c/33/cep-telefonu.html",
      "code": "mobile",
      "path": "1,2,12,32,33",
      "show_specifications": true,
      "manufacturer_title": "Markalar",
      "match_count": 19
    },
    {
      "id": 647,
      "name": "Akıllı Saat",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/647/20150126145642_1705.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/647/akilli-saat.html",
      "code": "akilli_saat",
      "path": "1,2,12,32,647",
      "show_specifications": true,
      "manufacturer_title": "Markalar",
      "match_count": 8
    },
    {
      "id": 34,
      "name": "Cep Telefonu Kılıfı",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/34/34.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/34/cep-telefonu-kilifi.html",
      "code": "cep-telefonu-kiliflari",
      "path": "1,2,12,32,34",
      "show_specifications": false,
      "manufacturer_title": "Markalar",
      "match_count": 5607
    },
    {
      "id": 72,
      "name": "Laptop",
      "children_count": 0,
      "image_url": "https://alve-c.scdn.gr/ds/categories/72/72.jpg",
      "parent_id": 9,
      "fashion": false,
      "layout_mode": "list",
      "web_uri": "https://www.alve.com/c/72/laptop.html",
      "code": "laptoplar",
      "path": "1,2,8,9,72",
      "show_specifications": true,
      "manufacturer_title": "Markalar",
      "match_count": 27
    },
    {
      "id": 19,
      "name": "Tablet",
      "children_count": 0,
      "image_url": "https://alve-d.scdn.gr/ds/categories/19/20150622142809_2e78d8bc.jpg",
      "parent_id": 9,
      "fashion": false,
      "layout_mode": "tiles",
      "web_uri": "https://www.alve.com/c/19/tablet.html",
      "code": "tablet",
      "path": "1,2,8,9,19",
      "show_specifications": true,
      "manufacturer_title": "Markalar",
      "match_count": 58
    }
  ],
  "meta": {
    "q": "apple",
    "alternatives": [

    ],
    "strong_matches": {
      "manufacturer": {
        "id": 28,
        "name": "Apple",
        "image_url": "https://alve-a.scdn.gr/ds/manufacturers/28/20150714114455_72bd4df9.png"
      }
    },
    "pagination": {
      "total_results": 80,
      "total_pages": 16,
      "page": 1,
      "per": 5
    }
  }
}

Query with strong hints for a specific SKU match

GET https://api.alve.com/search?q=samsung+7+edge+duos

View Response
Show Headers
Status: 200
{
  "categories": [
    {
      "id": 33,
      "name": "Cep Telefonu",
      "children_count": 0,
      "image_url": "https://alve-b.scdn.gr/ds/categories/33/20150622142746_9efad8e8.jpg",
      "parent_id": 32,
      "fashion": false,
      "layout_mode": "list",
      "web_uri": "https://www.alve.com/c/33/cep-telefonu.html",
      "code": "mobile",
      "family_id": 2,
      "show_manufacturers_filter": true,
      "path": "1,2,12,32,33",
      "show_specifications": true,
      "manufacturer_title": "Markalar"
    }
  ],
  "meta": {
    "q": "samsung 7 edge duos",
    "alternatives": [

    ],
    "strong_matches": {
      "sku": {
        "id": 4689810,
        "ean": "",
        "pn": "SM-G935FD",
        "name": "Galaxy S7 Edge Dual 32GB",
        "display_name": "Samsung Galaxy S7 Edge Dual 32GB",
        "category_id": 33,
        "first_product_shop_info": null,
        "click_url": null,
        "price_max": 2959.0,
        "price_min": 2599.0,
        "reviewscore": 5.0,
        "shop_count": 4,
        "plain_spec_summary": "Ağ Bağlantısı: 2G / 3G / 4G, Kamera: 12 MP, Ekran: 5.5 inç, 1440 x 2560 piksel, Dahili Hafıza: 32 GB, RAM: 4 GB, İşletim Sistemi: Android, 3600 mAh, Çift Hatlı",
        "manufacturer_id": 36,
        "future": false,
        "reviews_count": 12,
        "virtual": false,
        "images": {
          "main": "https://alve-d.scdn.gr/images/sku_main_images/004689/4689810/medium_20160606091304_samsung_galaxy_s7_edge_dual_32gb.jpeg",
          "alternatives": [
            "https://alve-b.scdn.gr/images/sku_images/002474/2474191/20160606091304_00d44e33.jpeg",
            "https://alve-d.scdn.gr/images/sku_images/002474/2474192/20160606091304_d0c595b0.jpeg",
            "https://alve-d.scdn.gr/images/sku_images/002474/2474193/20160606091307_dbcdad36.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474195/20160606091307_bd1ca5ca.jpeg",
            "https://alve-d.scdn.gr/images/sku_images/002474/2474194/20160606091307_3814bd55.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474196/20160606091309_17756499.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474197/20160606091310_d34dff81.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474198/20160606091311_09105600.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474199/20160606091313_23008049.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474200/20160606091316_d9a5241f.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474201/20160606091317_6a6ef43a.jpeg",
            "https://alve-d.scdn.gr/images/sku_images/002474/2474202/20160606091318_dc185265.jpeg",
            "https://alve-d.scdn.gr/images/sku_images/002474/2474203/20160606091320_a61bc0cd.jpeg",
            "https://alve-a.scdn.gr/images/sku_images/002474/2474204/20160606091321_03446167.jpeg",
            "https://alve-a.scdn.gr/images/sku_images/002474/2474205/20160606091325_161e5e0d.jpeg",
            "https://alve-c.scdn.gr/images/sku_images/002474/2474206/20160606091327_280f37cf.jpeg",
            "https://alve-a.scdn.gr/images/sku_images/002474/2474207/20160606091328_7be4db5b.jpeg"
          ]
        },
        "web_uri": "https://www.alve.com/s/4689810/Samsung-Galaxy-S7-Edge-Dual-32GB.html",
        "comparable": true
      }
    },
    "pagination": {
      "total_results": 1,
      "total_pages": 1,
      "page": 1,
      "per": 25
    }
  }
}

Query with results when parts of the query are omitted

GET https://api.alve.com/search?q=wrong+iphone

View Response
Show Headers
Status: 200
{
  "categories": [

  ],
  "meta": {
    "q": "wrong iphone",
    "alternatives": [
      {
        "term": "wrong",
        "count": 5,
        "drop": [
          {
            "token": "wrong",
            "dropped": false
          },
          {
            "token": "iphone",
            "dropped": true
          }
        ],
        "important": false
      },
      {
        "term": "iphone",
        "count": 24233,
        "drop": [
          {
            "token": "wrong",
            "dropped": true
          },
          {
            "token": "iphone",
            "dropped": false
          }
        ],
        "important": false
      }
    ],
    "strong_matches": {
    }
  }
}

Autocomplete

  GET /autocomplete
Name Type Description
q String The term to be autocompleted

GET https://api.alve.com/autocomplete?q=iph

View Response
Show Headers
Status: 200
{
  "autocomplete": [
    {
      "k": "iphone 5s kılıfı",
      "i": 3
    },
    {
      "k": "iphone 5s kılıfı",
      "i": 3,
      "d": {
        "n": "Cep Telefonu Kılıfı",
        "id": 34
      }
    },
    {
      "k": "iphone 6 kilif",
      "i": 3
    },
    {
      "k": "iphone 5s",
      "i": 3
    },
    {
      "k": "iphone 5s 16gb",
      "i": 3
    },
    {
      "k": "iphone 6s",
      "i": 3
    },
    {
      "k": "iphone 6s 128",
      "i": 3
    },
    {
      "k": "iphone",
      "i": 3
    },
    {
      "k": "iphone 6 16 gb",
      "i": 3
    },
    {
      "k": "iphone 6plus",
      "i": 3
    },
    {
      "k": "iphone 6",
      "i": 3
    },
    {
      "k": "iphone 6 plus",
      "i": 3
    }
  ]
}

Note that the results of the autocomplete are to be treated as search suggestions. When the user selects any of them you should perform a search with the selected keyphrase.