Skip to main content
POST
/tsukumo/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: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
keyword
string | null
Minimum string length: 1
category
string | null
maker
string[] | null
stock
string[] | null
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
specs
string[] | null
tags
string[] | null
free_shipping
boolean
default:false
ships_within_24h
boolean
default:false
ships_within_3_days
boolean
default:false
newly_stocked
boolean
default:false
include_discontinued
boolean
default:false
sort
enum<string>
default:recommended
Available options:
recommended,
newest,
maker_asc,
maker_desc,
price_asc,
price_desc

Response

Successful Response

id
string
required
url
string
required
@type
string
default:TsukumoProductCard
name
string | null
maker
string | null
maker_id
string | null
image
string | null
price
number | null
currency
string
default:JPY
price_text
string | null
availability
string | null
summary
string | null
stock_message
string | null
delivery_message
string | null
badges
string[]
rating
number | null
review_count
integer | null