虾皮(Shopee)的关键词搜索商品列表API允许开发者通过特定的关键词搜索Shopee平台上的商品,并返回相关的商品列表信息。以下是关于该API返回值的全面解析:
1. 请求和响应格式
- 请求方式:通常是GET或POST方法,取决于API的具体定义。
- 请求参数:包括关键词(keyword)、页数(page)、每页数量(limit)等。
- 响应格式:通常以JSON格式返回,包含状态码、消息和具体的商品列表数据。
2. 返回值结构
2.1 状态码和消息
status
或errcode
:表示请求的状态,如成功或失败。message
或errmsg
:与状态码对应的描述性信息。
2.2 商品列表数据(data
或 items
)
- 这是一个包含多个商品对象的数组,每个对象都代表了一个搜索到的商品。
商品对象属性
item_id
:商品的唯一标识符。title
:商品的名称或标题。image
:商品的图片链接或URL,用于展示商品外观。price
:商品的售价,可能包含原价、折扣价等信息。stock
:商品的库存数量,表示当前可售卖的数量。description
:对商品的详细描述,可能包含材质、尺寸、功能等信息。specification
:商品的详细规格参数,如颜色、尺寸、重量等。url
:商品的详情页链接,用户可以通过点击这个链接进入商品详情页面查看更多信息。
shopee.item_get
公共参数
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
key | String | 是 | 调用key(必须以GET方式拼接在URL中) |
secret | String | 是 | 调用密钥 |
api_name | String | 是 | API接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等] |
cache | String | 否 | [yes,no]默认yes,将调用缓存的数据,速度比较快 |
result_type | String | 否 | [json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读 |
lang | String | 否 | [cn,en,ru]翻译语言,默认cn简体中文 |
version | String | 否 | API版本 |
请求参数
请求参数:num_iid=264070136/5637247041&country=.com.my
参数说明:num_iid:商品ID-country:网站后缀(.com.my;.vn;.ph)
错误码解释
状态代码(error_code) | 状态信息 | 详细描述 | 是否收费 |
---|---|---|---|
0000 | success | 接口调用成功并返回相关数据 | 是 |
2000 | Search success but no result | 接口访问成功,但是搜索没有结果 | 是 |
4000 | Server internal error | 服务器内部错误 | 否 |
4001 | Network error | 网络错误 | 否 |
4002 | Target server error | 目标服务器错误 | 否 |
4003 | Param error | 用户输入参数错误 | 忽略 |
4004 | Account not found | 用户帐号不存在 | 忽略 |
4005 | Invalid authentication credentials | 授权失败 | 忽略 |
4006 | API stopped | 您的当前API已停用 | 忽略 |
4007 | Account stopped | 您的账户已停用 | 忽略 |
4008 | API rate limit exceeded | 并发已达上限 | 忽略 |
4009 | API maintenance | API维护中 | 忽略 |
4010 | API not found with these values | API不存在 | 忽略 |
4012 | Please add api first | 请先添加api | 忽略 |
4013 | Number of calls exceeded | 调用次数超限 | 忽略 |
4014 | Missing url param | 参数缺失 | 忽略 |
4015 | Wrong pageToken | 参数pageToken有误 | 忽略 |
4016 | Insufficient balance | 余额不足 | 忽略 |
4017 | timeout error | 请求超时 | 否 |
5000 | unknown error | 未知错误 | 否 |
3. 分页信息
- 如果搜索结果数量较多,API通常会支持分页查询。在返回值中,可能包含当前页码(
page
)、每页数量(limit
)、总页数(total_pages
)或总商品数(total_count
)等信息。
4. 其他注意事项
- 根据API的文档,了解其他可能的返回字段和参数。
- 注意API的调用频率限制,避免因为频繁调用而被限制访问。
- 处理异常和错误情况,如网络错误、参数错误、权限问题等。