Skip to main content
POST
/
api
/
ah
/
products
/
search
/ah/products/search
curl --request POST \
  --url https://api.anysite.io/api/ah/products/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "id": 123,
    "@type": "@ah_search_product",
    "hq_id": 123,
    "title": "<string>",
    "brand": "<string>",
    "main_category": "<string>",
    "sub_category": "<string>",
    "shop_type": "<string>",
    "sales_unit_size": "<string>",
    "unit_price_description": "<string>",
    "nutriscore": "<string>",
    "price": 123,
    "list_price": 123,
    "min_best_before_days": 123,
    "is_bonus": false,
    "is_sponsored": false,
    "is_orderable": true,
    "is_available_online": true,
    "is_sample": false,
    "is_nix18": false,
    "is_stapel_bonus": false,
    "is_infinite_bonus": false,
    "is_virtual_bundle": false,
    "bonus_mechanism": "<string>",
    "bonus_start_date": "<string>",
    "bonus_end_date": "<string>",
    "promotion_type": "<string>",
    "order_availability_status": "<string>",
    "description": "<string>",
    "description_highlights": "<string>",
    "image": "<string>",
    "images": [],
    "property_icons": [],
    "discount_labels": [],
    "virtual_bundle_items": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required

Search keyword

Minimum string length: 1
Examples:

"melk"

"koffie"

"pindakaas"

count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
integer
required
@type
string
default:@ah_search_product
hq_id
integer | null
title
string | null
brand
string | null
main_category
string | null
sub_category
string | null
shop_type
string | null
sales_unit_size
string | null
unit_price_description
string | null
nutriscore
string | null
price
number | null
list_price
number | null
min_best_before_days
integer | null
is_bonus
boolean
default:false
is_sponsored
boolean
default:false
is_orderable
boolean | null
is_available_online
boolean | null
is_sample
boolean
default:false
is_nix18
boolean
default:false
is_stapel_bonus
boolean
default:false
is_infinite_bonus
boolean
default:false
is_virtual_bundle
boolean
default:false
bonus_mechanism
string | null
bonus_start_date
string | null
bonus_end_date
string | null
promotion_type
string | null
order_availability_status
string | null
description
string | null
description_highlights
string | null
image
string | null
images
string[]
property_icons
string[]
discount_labels
AhSearchDiscountLabel · object[]
virtual_bundle_items
AhVirtualBundleItem · object[]