Skip to main content
POST
/petsplace/products/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: 1 <= x <= 1000
timeout
integer
default:300
Required range: 20 <= x <= 1500
keyword
string
default:""
sort
enum<string>
default:relevance
Available options:
relevance,
price_asc,
price_desc,
title_asc,
title_desc
turnover_group
enum<string> | null
Available options:
Hond,
Kat,
Knaagdier,
Vogel,
Vis,
Paard,
Reptiel,
Hengelsport,
Duif,
Boerderijdier,
Buiten(Dieren),
Plant & Zorg,
Werken In De Tuin,
Vijver,
Huis,
Wonen & Leven,
Kleding & Schoeisel,
Leisure,
Events,
Special
category
string | null
brand
string | null
product_group
string | null
sub_product_group
string | null
health
string | null
flavor
string | null
packaging
enum<string> | null
Available options:
Alu,
Alukuipje,
Blik,
Cups,
Doos,
Emmer,
Flacon,
Fles,
Folie,
Pak,
Pot,
Pouch,
Sachet,
Spuitbus,
Tetrapack,
Tube,
Verspack,
Versvlees,
Worst,
Zak
size
enum<string> | null
Available options:
Giant,
Large,
Maxi,
Medium,
Mini,
Regular,
Small,
Xlarge,
Xsmall
clothing_size
string | null
weight
string | null
volume
string | null
color
string | null
special_type
string | null
on_promotion
boolean | null
availability
enum<string> | null
Available options:
in_stock,
out_of_stock
price_min
number | null
Required range: x >= 0
price_max
number | null
Required range: x >= 0

Response

Successful Response

id
string
required
@type
string
default:PetsplaceProductSearchItem
sku
string | null
gtin13
string | null
name
string | null
brand
string | null
image
string | null
images
string[]
price
number | null
final_price
number | null
sale_price
number | null
currency
string | null
special_type
string | null
has_promotion
boolean | null
promotion_id
string | null
availability
string | null
is_in_stock
boolean | null
stock
integer | null
turnover_group
string | null
sub_turnover_group
string | null
sub_turnover_group3
string | null
categories
string[]
product_group
string | null
sub_product_group
string | null
sub_product_group2
string | null
health
string | null
flavor
string | null
packaging
string | null
size
string | null
clothing_size
string | null
weight
string | null
volume
string | null
color
string | null
url
string | null