Autocomplete

2min

Autocomplete Results
When making a request with the  type  parameter set to  type=autocomplete  Countdown API will return autocomplete suggestions for the search term specified in the  search_term  parameter, on the Ebay domain specified in the  ebay_domain  parameter.
Autocomplete Suggestions
﻿
An example of the JSON object returned from an Autocomplete request is shown below:
JSON
{
  "request_info": {
    "success": true,
    "credits_used": 1,
    "credits_remaining": 999
  },
  "request_metadata": {
    "id": "48d63ef58b3eb240d5b18115b674c4170faba51f",
    "created_at": "2021-01-01T00:00:00.000Z",
    "processed_at": "2021-01-01T00:00:00.001Z",
    "total_time_taken": 0.1
  },
  "request_parameters": {
    "type": "autocomplete",
    "ebay_domain": "ebay.com",
    "search_term": "memory"
  },
  "autocomplete_results": [
    {
      "suggestion": "memory card",
      "type": "KEYWORD",
      "category_id": 9394,
      "category_name": "Cell Phone Accessories"
    },
    {
      "suggestion": "memory card",
      "type": "KEYWORD",
      "category_id": 15200,
      "category_name": "Camera, Drone & Photo Accessories"
    },
    {
      "suggestion": "memory foam mattress",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam pillow",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam mattress topper",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory ram",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory stick",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory lane rudolph",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory stick pro duo",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam mattress queen",
      "type": "KEYWORD"
    }
  ]
}
{
  "request_info": {
    "success": true,
    "credits_used": 1,
    "credits_remaining": 999
  },
  "request_metadata": {
    "id": "48d63ef58b3eb240d5b18115b674c4170faba51f",
    "created_at": "2021-01-01T00:00:00.000Z",
    "processed_at": "2021-01-01T00:00:00.001Z",
    "total_time_taken": 0.1
  },
  "request_parameters": {
    "type": "autocomplete",
    "ebay_domain": "ebay.com",
    "search_term": "memory"
  },
  "autocomplete_results": [
    {
      "suggestion": "memory card",
      "type": "KEYWORD",
      "category_id": 9394,
      "category_name": "Cell Phone Accessories"
    },
    {
      "suggestion": "memory card",
      "type": "KEYWORD",
      "category_id": 15200,
      "category_name": "Camera, Drone & Photo Accessories"
    },
    {
      "suggestion": "memory foam mattress",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam pillow",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam mattress topper",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory ram",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory stick",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory lane rudolph",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory stick pro duo",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam",
      "type": "KEYWORD"
    },
    {
      "suggestion": "memory foam mattress queen",
      "type": "KEYWORD"
    }
  ]
}
﻿
Countdown API returns the following properties for Autocomplete requests:
Property
Type
Description
autocomplete_results
array
Autocomplete Results Array 
The autocomplete results array contains details of each of the autocomplete suggestions returned from the query.
suggestion
string
The text of the autocomplete suggestion.
﻿
type
string
The type of the suggestion.
﻿
category_id
string
A category ID for the first suggestion (only shown against the first suggestion).
﻿
category_name
string
A category name for the first suggestion (only shown against the first suggestion).
﻿
Next Steps
     Autocomplete Parameters﻿

Property	Type	Description
autocomplete_results	array	Autocomplete Results Array The autocomplete results array contains details of each of the autocomplete suggestions returned from the query. suggestion string The text of the autocomplete suggestion. type string The type of the suggestion. category_id string A category ID for the first suggestion (only shown against the first suggestion). category_name string A category name for the first suggestion (only shown against the first suggestion).

Updated 08 Aug 2024

Did this page help you?

Deals

GTIN/ISBN/UPC/EAN to EPID Lookups