如何获取淘宝客商品列表api API 返回值说明？

goods_list-商品列表api 

aobaoke.goods_list

公共参数

请求地址: https://api-gw-4.cn/taobaoke/goods_list

名称	类型	必须	描述
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版本

请求参数

请求参数：pageId=1&pageSize=40&sort=&cids=&subcid=&taoQiangGou=&tmall=&tchaoshi=&goldSeller=&haitao=&pre=&brand=&priceLowerLimit=&priceUpperLimit=&couponPriceLowerLimit=&commissionRateLowerLimit=&monthSalesLowerLimit=&version=&appKey=&appSecret=

参数说明： pageSize 每页条数 否 Number 默认为100，最大值200，若小于10，则按10条处理，每页条数仅支持输入10,50,100,200
pageId 分页id 是 String 默认为1，支持传统的页码分页方式和scroll_id分页方式，根据用户自身需求传入值。示例1：商品入库，则首次传入1，后续传入接口返回的pageid，接口将持续返回符合条件的完整商品列表，该方式可以避免入口商品重复；示例2：根据pagesize和totalNum计算出总页数，按照需求返回指定页的商品（该方式可能在临近页取到重复商品）
sort 排序方式 否 String 默认为0，0-综合排序，1-商品上架时间从高到低，2-销量从高到低，3-领券量从高到低，4-佣金比例从高到低，5-价格（券后价）从高到低，6-价格（券后价）从低到高
cids 一级类目id 否 String 大淘客的一级分类id，如果需要传多个，以英文逗号相隔，如：”1,2,3”。当一级类目id和二级类目id同时传入时，会自动忽略二级类目id
subcid 二级类目id 否 Number 大淘客的二级类目id，通过超级分类API获取。仅允许传一个二级id，当一级类目id和二级类目id同时传入时，会自动忽略二级类目id
juHuaSuan 是否聚划算 否 Number 1-聚划算商品，0-所有商品，不填默认为0
taoQiangGou 是否淘抢购 否 Number 1-淘抢购商品，0-所有商品，不填默认为0
tmall 是否天猫商品 否 Number 1-天猫商品，0-所有商品，不填默认为0
tchaoshi 是否天猫超市商品 否 Number 1-天猫超市商品，0-所有商品，不填默认为0
goldSeller 是否金牌卖家 否 Number 1-金牌卖家，0-所有商品，不填默认为0
haitao 是否海淘商品 否 Number 1-海淘商品，0-所有商品，不填默认为0
pre 是否预告商品 否 Number 1-预告商品，0-非预告商品
brand 是否品牌商品 否 Number 1-品牌商品，0-所有商品，不填默认为0
brandIds 品牌id 否 String 当brand传入0时，再传入brandIds将获取不到结果。品牌id可以传多个，以英文逗号隔开，如：”345,321,323”
priceLowerLimit 价格（券后价）下限 否
priceUpperLimit 价格（券后价）上限 否
couponPriceLowerLimit 最低优惠券面额
commissionRateLowerLimit 最低佣金比率
monthSalesLowerLimit 最低月销量
appKey：大淘客key
appSecret:大淘宝密钥

响应参数

Version: Date:

名称	类型	必须	示例值	描述
num_iid	String	0
pageId	String	0
pageSiz	String	0
sor	String	0
cid	String	0
subci	String	0
taoQiangGo	String	0
tmal	String	0
tchaosh	String	0
goldSelle	String	0
haita	String	0
pr	String	0
bran	String	0
priceLowerLimi	String	0
priceUpperLimi	String	0
couponPriceLowerLimi	String	0
commissionRateLowerLimi	String	0
monthSalesLowerLimi	String	0

请求示例

-- 请求示例 url 默认请求参数已经URL编码处理
curl -i "https://api-gw-4.cn/taobaoke/goods_list/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&pageId=1&pageSize=40&sort=&cids=&subcid=&taoQiangGou=&tmall=&tchaoshi=&goldSeller=&haitao=&pre=&brand=&priceLowerLimit=&priceUpperLimit=&couponPriceLowerLimit=&commissionRateLowerLimit=&monthSalesLowerLimit=&version=&appKey=&appSecret="

响应示例

异常示例

相关资料

错误码解释

状态代码(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	未知错误	否

API 工具

淘宝客（Taobao Affiliate）是淘宝的联盟营销平台，允许合作伙伴通过推广商品获得佣金。淘宝客商品列表API是用来获取淘宝商品信息的接口之一。以下是淘宝客商品列表API的返回值示例和说明。请注意，实际的返回值可能会因API版本、调用参数以及淘宝平台本身的更新而有所不同，因此强烈建议查阅淘宝官方API文档以获取最准确的信息。

### 示例返回值

```json
{
  "taobao_response": {
    "num_iids": 2,        // 请求中传入的商品ID数量
    "total_results": 2,   // 实际返回的商品结果数量
    "item_list": [
      {
        "num_iid": "123456789",      // 商品数字ID
        "title": "示例商品1",        // 商品标题
        "pic_url": "http://img.taobao.com/example/pic1.jpg", // 商品图片URL
        "price": "99.00",            // 商品价格
        "click_url": "https://item.taobao.com/item.htm?id=123456789", // 商品点击链接
        "commission_rate": "0.05",   // 佣金比率，例如0.05表示5%
        "commission_num": "4.95",    // 佣金金额，根据商品价格和佣金比率计算得出
        "volume": "1000",            // 近期成交量
        // ... 可能有更多字段，如店铺信息、优惠信息等
      },
      {
        // 第二个商品的信息...
        "num_iid": "987654321",
        "title": "示例商品2",
        "pic_url": "http://img.taobao.com/example/pic2.jpg",
        "price": "199.00",
        "click_url": "https://item.taobao.com/item.htm?id=987654321",
        "commission_rate": "0.10",
        "commission_num": "19.90",
        "volume": "500",
        // ...
      }
    ],
    "page_no": 1,          // 当前页码
    "page_size": 20,       // 每页返回的商品数量
    "has_next": false,     // 是否有下一页数据
    "error_msg": "",       // 错误信息，如果请求成功则为空
    "code": 0              // 返回码，0通常表示成功
  }
}
```

### 返回值字段说明

- **taobao_response**: API返回的主体内容。
  - **num_iids**: 请求中传入的商品ID数量。
  - **total_results**: 实际返回的商品结果数量。
  - **item_list**: 商品列表数组，包含多个商品信息对象。
    - **num_iid**: 商品数字ID。
    - **title**: 商品标题。
    - **pic_url**: 商品主图链接。
    - **price**: 商品售价。
    - **click_url**: 商品点击链接，用户点击后会跳转到商品详情页。
    - **commission_rate**: 佣金比率，通常以小数形式表示，例如0.05表示5%。
    - **commission_num**: 根据商品价格和佣金比率计算出的佣金金额。
    - **volume**: 商品的近期成交量。
    - **...**: 可能还有其他字段，如店铺信息、优惠信息等。
  - **page_no**: 当前页码，用于分页查询。
  - **page_size**: 每页返回的商品数量。
  - **has_next**: 是否还有下一页数据。
  - **error_msg**: 错误信息，如果请求成功则为空。
  - **code**: 返回码，0通常表示成功，其他值表示不同的错误。

### 注意事项

1. **错误处理**：检查`code`和`error_msg`字段以判断请求是否成功，如果不成功则根据错误信息进行处理。
2. **分页处理**：如果`has_next`为`true`，表示还有更多数据，可以继续请求下一页。
3. **数据更新**：由于淘宝商品信息会实时更新，因此获取的数据可能会有所变化。
4. **API限制**：注意淘宝客API的使用限制，如调用频率、返回数据量等。
5. **数据准确性**：返回的商品信息可能会因为各种原因（如商品下架、信息变更等）而不准确，开发者需要自行验证### 返回值字段说明（续）

#### 商品信息对象（item_list中的对象）

- **num_iid**: `string` 类型，表示商品的数字ID，是商品在淘宝平台上的唯一标识。

- **title**: `string` 类型，表示商品的标题，通常是用户搜索和了解商品时首先看到的信息。

- **pic_url**: `string` 类型，表示商品的主图链接，即用户在搜索结果或商品详情页中看到的图片。

- **price**: `string` 类型，表示商品的售价，通常以元为单位，并保留两位小数。

- **click_url**: `string` 类型，表示商品的点击链接，用户点击后通常会跳转到商品的详情页，以便于进一步了解商品信息或进行购买。

- **commission_rate**: `string` 类型，表示佣金比率，通常以小数形式表示，例如“0.05”表示5%。这是淘宝客推广商品时，推广者可以获得的佣金比例。

- **commission_num**: `string` 类型，表示根据商品价格和佣金比率计算出的佣金金额。例如，如果商品价格是“100.00”，佣金比率是“0.05”，则佣金金额是“5.00”。

- **volume**: `string` 类型，表示商品的近期成交量，即最近一段时间内该商品的售出数量。这可以作为衡量商品受欢迎程度的一个指标。

#### 其他返回字段

- **page_no**: `int` 类型，表示当前页码，用于分页查询。例如，如果`page_no`是1，则表示返回的是第一页的数据。

- **page_size**: `int` 类型，表示每页返回的商品数量。例如，如果`page_size`是20，则表示每页返回20个商品。

- **has_next**: `boolean` 类型，表示是否还有下一页数据。如果`has_next`为`true`，则表示还有更多数据可以查询；如果为`false`，则表示已经是最后一页。

- **error_msg**: `string` 类型，表示错误信息。如果请求成功，该字段通常为空；如果请求失败，则会包含失败的原因。

- **code**: `int` 类型，表示返回码。通常，0表示请求成功，其他值表示不同的错误或异常情况。具体的错误码和含义可以参考淘宝客API的官方文档。

### 注意事项（续）

6. **数据时效性**：由于商品信息会实时更新，所以获取的数据可能不是最新的。开发者需要根据自己的业务需求考虑数据的时效性问题。

7. **API调用限制**：淘宝客API通常会有调用频率限制，即单位时间内允许的请求次数。超出限制可能会导致请求被限制或产生额外的费用。因此，开发者需要合理规划API的调用策略，避免频繁请求。

8. **数据缓存**：为了提高性能和响应速度，开发者可以考虑将获取到的数据进行缓存。但需要注意的是，缓存的数据可能会过期或变得不准确，因此需要及时更新和验证缓存数据的有效性。

9. **数据隐私和安全**：在处理和存储用户数据时，开发者需要遵守相关的隐私政策和法律法规，确保用户数据的安全性和隐私性。

10. **错误处理和异常处理**：在调用API时，可能会遇到各种错误和异常情况。开发者需要合理处理这些错误和异常，避免程序崩溃或数据丢失。同时，也要关注API返回的错误码和错误信息，以便及时定位和解决问题。

11. **文档和社区支持**：淘宝客API通常会有官方的文档和社区支持。开发者在开发过程中可以参考官方文档了解API的详细使用方法和规范，同时也可以在社区中寻求帮助和解决问题。