Skip to main content
POST
/hm/products/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
locale
enum<string>
default:en_us
Available options:
en_us,
en_gb,
de_de,
fr_fr,
es_es,
it_it

Response

Successful Response

id
string
required
@type
string
default:HmProduct
name
string | null
brand
string | null
url
string | null
alias
string | null
price
number | null
list_price
number | null
price_formatted
string | null
image
string | null
images
string[]
color_name
string | null
colors
object[]
sizes
object[]
is_in_stock
boolean | null
is_coming_soon
boolean | null
is_new_arrival
boolean | null
is_multipack
boolean | null
has_video
boolean | null
category
string | null