COMMERCE_SERP 并设置 site ulta,按商城的顺序获取搜索结果中的商品;向 COMMERCE_PRODUCT 传入商品的 url,读取该商品。每次完成的搜索或商品页面消耗 0.5 积分。
搜索
GET /v1/async/task/{id} 或通过 webhook 接收。参见异步任务。
参数
site:必填。值为ulta。query:必填。搜索词,1-500 个字符。limit:可选整数,范围 1-40,默认 20。country:可选。默认是商城所在国家US。其他国家会以422 REGION_UNSUPPORTED拒绝。
include:即使是 include: {},也会在冻结积分前返回针对 payload.include 的 422 VALIDATION_ERROR。
响应示例
结果字段
site、query和country回显请求。returnedCount是products中的商品数。- 每个商品包含
rank、productId、title和url。productId是商城自己的商品 ID。rank遵循商城的默认排序,商城标为广告的商品会被跳过。 - 搜索结果页显示时返回
price、rating、reviewCount、imageUrl和brand。price是以商品的currency(ISO 4217)计的数字;不同规格分别定价时,取最低价。 rating为五分制。像 999+ 这样的缩写评价数不会返回。- 每次搜索从商城搜索结果的第一页获取商品。 Ulta 会把部分品牌名搜索转到品牌页面,此时返回该页面的商品。
商品页面
参数
url:必填。Ulta 的商品页面,最多 2,048 个字符,格式为ulta.com/p/{name}-{id}。搜索返回的商品url可直接使用。跟踪代码等不影响结果的参数会在读取前去掉。country:可选。默认是页面所在国家US。其他国家会以422 REGION_UNSUPPORTED拒绝。
include:即使是 include: {},也会在冻结积分前返回针对 payload.include 的 422 VALIDATION_ERROR。
响应示例
结果字段
site、country、url和productId标识页面。url是读取的页面,productId与搜索返回的 ID 一致。title始终返回。页面显示时返回brand、price、currency、inStock、rating、reviewCount、images、description、descriptionImages、specs、options、categories和gtin。price是页面最初显示、未计优惠券和运费的购买价格,以currency(ISO 4217)计。inStock是商品的库存状态。rating为五分制,保留两位小数。reviewCount是评价数。images按页面顺序列出商品图库中最多 30 张图片。description是每段一行的纯文本,最多 10,000 个字符;只出现在图片中的文字不包含在内。descriptionImages按页面顺序列出商品描述中最多 300 张图片。卖家放在描述里的横幅和公告也会一并返回,图片中的文字不会读取。specs列出商品详情中最多 100 组{ name, value }。options列出尺寸或颜色等最多 20 个选项,每个选项最多 100 个values;其他字段描述页面默认打开的选项。categories从最宽的类目排到最窄的类目,最多 10 级。gtin是页面列出的 UPC、EAN 或 JAN。
错误与计费
- 没有返回任何商品的搜索以失败任务结束。
- 商城以 404 或 410 响应的商品页面(例如已下架的商品)会以
PAGE_UNAVAILABLE结束任务,消息中带有商城的响应。如果商城以 403、412、429 或 435 拒绝读取,任务会等待并在最多 6 分钟内重新请求。其他读取失败,以及持续更久的拒绝,以ENGINE_NO_RESULT结束。 - 只对完成的任务计费:每次搜索或每个商品页面 0.5 积分。