当前位置: API文档

goods.ApiGoods.search(平台货品查询)

¥标准

1.接口说明

1.1 接口描述:获取ERP的平台货品资料
1.2 适用版本:客户端 V1.2.5.6及以上版本
1.3 增量获取:支持
1.4 时间跨度:start_time和end_time最大跨度为30天

1.5注意事项:开始时间和结束时间是平台货品数据最后修改时间的范围

为了达到保护用户隐私数据安全的目的本接口不返回淘系订单数据相关平台规则点击这里淘系数据获取办法点击这里

2.调用场景

2.1 举例说明:自研商城、SCMSRM、财务系统、SAP等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
卖家账号, 由旺店通分配
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段
saltString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampint
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeint
分页大小,分页查询必传
分页编号page_noint
分页编号,分页查询必传
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0         

   3.3 业务请求参数

名称字段类型长度
必须描述

查询参数

params

Map<String, Object>


查询参数

分页

pager

pager


分页

params

名称字段类型长度
必须描述
店铺编号shop_noString20

店铺编号

平台货品号goods_idString40

平台货品号(使用该字段客户端需要升级到1.2.4.9及以上版本!!)

平台sku idspec_idString40

平台sku id(使用该字段客户端需要升级到1.2.4.9及以上版本!!)

开始时间start_timeString40

起始修改时间, 时间格式 YYYY-MM-DD HH:MM:SS

结束时间end_time

String

40

结束修改时间

pager

名称字段类型长度
必须描述
分页大小page_sizeInt4

分页大小

页号page_noInt4

从0开始

4.响应参数

名称字段类型长度
必须描述
状态码statusInt

状态码,0表示正常

错误信息messageString

无错误信息不返回

货品数据data

Map<String, Object>


货品相关数据

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项(如隐私数据淘系平台不返回,其他平台正常返回

名称字段类型长度
必须描述

货品数据

goods_list

List<Map<String, Object>>


货品数据

总数

total_count

Int

11

查询条件总单据数

goods_list

名称字段类型长度
必须描述
店铺id

shop_id

Int11店铺id
店铺编号

shop_no

String20店铺编号
店铺名称

shop_name

String40
店铺名称
货品名称goods_nameString255平台货品名称
平台规格名称spec_nameString100平台规格名称
平台规格编码spec_outer_idString40平台规格编码
平台货品编码outer_idString40

平台货品编码

平台货品IDgoods_idString40平台货品ID
平台规格IDspec_idString40平台规格ID
活动状态is_deletedInt1

0正常货品,1平台删除,2手工删除

平台价格price

Decimal(19,4)


平台价格
平台库存stock_num

Decimal(19,4)


平台库存
状态statusInt40删除,1在架,2下架
是否自动匹配

is_auto_match

Int1

1自动匹配,0 手动匹配

系统货品类型

match_target_type

4Int1

0未指定,1单品,2组合装

占用库存

hold_stock

Decimal(19,4)


占用库存
占用方式

hold_stock_type

Int

4

1拍下减库存 

2付款减库存

是否自动上架

is_auto_listing

bool

1是否自动上架
是否自动下架

is_auto_delisting

bool

1是否自动下架
修改时间

modified

String

40

系统中平台货品最后修改时间, 时间格式 YYYY-MM-DD HH:MM:SS

系统商家编码

merchant_no

String

40

match_target_type=1时返回的为单品商家编码、match_target_type=2时返回的为组合装商家编码

系统货品名称

merchant_name

String

255

match_target_type=1时返回的为单品货品名称、match_target_type=2时返回的为组合装货品名称

系统规格编码

merchant_code

String

40

match_target_type=1时返回的为单品规格编码、match_target_type=2时返回为空字符串

5.请求示例

jason格式请求报文

[{
"start_time":"2020-05-26 16:10:40","end_time":"2020-05-26 16:11:46","shop_no":"test"
}]
PHP
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
  
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret"); 

$parMap = new stdClass();
$parMap->start_time = "2020-05-26 16:10:40";
$parMap->end_time = "2020-05-26 16:11:46";
$parMap->shop_no='test';

$pager = new Pager(10, 0, true);
$data = $client->pageCall("goods.ApiGoods.search", $pager, $parMap);

?>
JAVA
C#

6.响应示

   6.1 正常响应示例 

JSON
{
    "status":0,
    "data":{
        "goods_list":[
            {
                "is_auto_match":1,
                "goods_name":"阿拉蕾",
                "hold_stock":0.0000,
                "merchant_no":"all",
                "merchant_code":"all",
                "stock_num":0.0000,
                "goods_id":"567346060162",
                "hold_stock_type":0,
                "merchant_name":"颜色:粉红色",
                "rec_id":2458,
                "shop_name":"test",
                "outer_id":"all",
                "spec_outer_id":"",
                "is_deleted":0,
                "spec_id":"3961183439381",
                "price":10.0000,
                "is_auto_delisting":true,
                "is_auto_listing":true,
                "modified":"2020-05-26 16:10:46",
                "spec_name":"颜色分类:深蓝色【周期购2020.01.10】",
                "match_target_type":1,
                "status":1,
                "shop_no":"test"
            }],
        "total_count":1
    }
}

   6.2 异常响应示例

JSON
{
"status": 100,
"message": "参数中必须包含起止时间"
}




常用工具