COMMERCE_SERP with site qoo10 to get the products a search shows, in the store’s order, or COMMERCE_PRODUCT with a product’s url to read that product. A completed search or product page costs 0.5 credits.
Search
GET /v1/async/task/{id} or receive its webhook. See Async tasks.
Parameters
site: Required.qoo10.query: The search query, 1-500 characters. Required unless you sendurl.url: A Qoo10 shop page to read instead of searching, such ashttps://www.qoo10.jp/shop/LG-BEAUTY; its query string is dropped. Sendqueryorurl, not both.limit: Optional integer from 1 to 40, default 20. Withurl, from 1 to 200, default 200.country: Optional. Defaults toJP, the store’s country. Any other country is rejected with422 REGION_UNSUPPORTED.
include: even include: {} returns 422 VALIDATION_ERROR on payload.include before credits are held.
Response example
Result fields
site,queryandcountryecho the request.returnedCountis the number of entries inproducts. A task withurlreturnsurlinstead ofquery: the shop page that was read.- Each product includes
rank,productId,titleandurl.productIdis the store’s own product ID.rankfollows the store’s default order, and listings the store marks as sponsored are left out. price,rating,reviewCount,imageUrlandbrandappear when the results page shows them.priceis a number in the product’scurrency(ISO 4217); when sizes are priced apart, it is the lowest one.ratinguses a five-point scale. Abbreviated review counts such as 999+ are left out.- Each search returns products from the store’s first results page.
- A shop page shows the products the seller places in the shop’s sections.
productslists them in page order and up tolimit, each product once, andpriceis the price each card shows, with the shop’s coupon applied where the card applies it.
Product page
Parameters
url: Required. A product page on Qoo10, up to 2,048 characters:qoo10.jp/g/{id}. Producturlvalues from a search work as they are. Parameters the result does not depend on, such as tracking codes, are dropped before the page is read.country: Optional. Defaults toJP, the page’s country. Any other country is rejected with422 REGION_UNSUPPORTED.
include: even include: {} returns 422 VALIDATION_ERROR on payload.include before credits are held.
Response example
Result fields
site,country,urlandproductIdidentify the page.urlis the page that was read, andproductIdmatches the one a search returns.titleis always present.brand,price,listPrice,currency,inStock,rating,reviewCount,imagesanddescriptionImagesappear when the page shows them.priceis what a shopper pays as the page first shows it, before coupons and delivery, incurrency(ISO 4217).listPriceis the regular price the page strikes through, present when it is aboveprice.inStockis the product’s stock status.ratinguses a five-point scale with two decimals.reviewCountis the number of reviews.imageslists up to 30 photos from the product’s gallery, in page order.descriptionImageslists up to 300 images from the product description, in page order. Banners and notices that sellers place in their description come along, and text inside the images is not read.
Errors and billing
- A search that returns no products ends as a failed task.
- A product page the store answers with 404 or 410, such as a removed product, ends the task with
PAGE_UNAVAILABLE, and the message carries the store’s answer. When the store refuses the read with 403, 412, 429 or 435, the task waits and asks again for up to 6 minutes. Other failed reads, and a refusal that lasts longer, end withENGINE_NO_RESULT. - Only completed tasks are charged: 0.5 credits for a search or a product page.