Skip to main content
POST
/
api
/
yahoo_shopping
/
products
/
search
/yahoo_shopping/products/search
curl --request POST \
  --url https://api.anysite.io/api/yahoo_shopping/products/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300,
  "price_min": 1,
  "price_max": 1,
  "category_id": "<string>",
  "brand_id": "<string>",
  "free_shipping": false,
  "sort": "recommended"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@yahoo_shopping_search_product",
    "item_code": "<string>",
    "store_alias": "<string>",
    "title": "<string>",
    "image": "<string>",
    "price": 123,
    "actual_price": 123,
    "list_price": 123,
    "discount_rate": 123,
    "currency": "JPY",
    "point": 123,
    "point_rate": 123,
    "is_free_shipping": false,
    "is_used": false,
    "has_video": false,
    "brand": "<string>",
    "brand_id": "<string>",
    "jan_code": "<string>",
    "category_id": "<string>",
    "rating": 123,
    "review_count": 123,
    "store": {
      "@type": "@yahoo_shopping_search_product_store",
      "alias": "<string>",
      "name": "<string>",
      "rating": 123,
      "rating_count": 123
    }
  }
]

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:

"iphone"

"nintendo switch"

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
price_min
integer | null

Minimum price filter (JPY)

Required range: x >= 0
price_max
integer | null

Maximum price filter (JPY)

Required range: x >= 0
category_id
string | null

Category ID filter

brand_id
string | null

Brand ID filter

condition
enum<string> | null

Item condition filter

Available options:
new,
used
free_shipping
boolean
default:false

Only items with free shipping

sort
enum<string>
default:recommended

Result ordering

Available options:
recommended,
price_asc,
price_desc,
review_count,
review_score,
discount_rate

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@yahoo_shopping_search_product
item_code
string | null
store_alias
string | null
title
string | null
image
string | null
price
integer | null
actual_price
integer | null
list_price
integer | null
discount_rate
integer | null
currency
string
default:JPY
point
integer | null
point_rate
number | null
is_free_shipping
boolean
default:false
is_used
boolean
default:false
has_video
boolean
default:false
brand
string | null
brand_id
string | null
jan_code
string | null
category_id
string | null
rating
number | null
review_count
integer | null
store
YahooShoppingSearchProductStore ยท object