当前位置: API文档
goods.ApiGoods.search(平台货品查询)
| 1.1 接口描述:获取ERP的平台货品资料 |
| 1.2 适用版本:客户端 V1.4.4.7及以上版本 |
| 1.3 增量获取:支持 |
| 1.4 时间跨度:start_time和end_time最大跨度为30天 |
1.5注意事项:【权限校验】:店铺权限 开始时间和结束时间是平台货品数据最后修改时间的范围 为了达到保护用户隐私数据安全的目的,本接口不返回淘系、拼多多及系统供销平台货品数据,淘系及系统供销平台相关规则点击这里,淘系及系统供销平台数据获取办法点击这里,拼多多请自行对接平台获取。 |
| 2.1 举例说明:自研商城、SCM、SRM、财务系统、SAP等系统的对接 |
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | http://47.92.239.46/openapi |
| 正式环境 | http://wdt.wangdian.cn/openapi |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 卖家账号 | sid | String | 是 | 卖家账号, 由旺店通分配 | |
| 接口账号 | key | String | 是 | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
| 盐 | salt | String | 是 | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
| 接口名称 | method | String | 是 | 调用的接口名称 | |
| 版本号 | v | String | 是 | 1.0 | |
| 秒级时间戳 | timestamp | int | 是 | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
| 签名 | sign | String | 是 | 签名 | |
| 分页大小 | page_size | int | 否 | 分页大小,分页查询必传 | |
| 分页编号 | page_no | int | 否 | 分页编号,分页查询必传,标准接口page_no从0开始 | |
| 是否计算查询结果的总条数 | calc_total | int | 否 | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | 是 | 查询参数 | |
分页 | pager | pager | 是 | 分页 |
params
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 店铺编号 | shop_no | String | 20 | 否 | 店铺编号 |
| 平台货品ID | goods_id | String | 40 | 否 | 平台货品ID |
| 平台规格ID | spec_id | String | 40 | 否 | 平台规格ID |
| 开始时间 | start_time | String | 40 | 是 | 起始修改时间, 时间格式 YYYY-MM-DD HH:MM:SS |
| 结束时间 | end_time | String | 40 | 是 | 结束修改时间 |
pager
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 分页大小 | page_size | Int | 4 | 否 | 分页大小 |
| 页号 | page_no | Int | 4 | 否 | 从0开始 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 状态码 | status | Int | 是 | 状态码,0表示正常 | |
| 错误信息 | message | String | 是 | 无错误信息不返回 | |
| 货品数据 | data | Map<String, Object> | 是 | 货品相关数据 |
data
响应参数说明示例值或者格式、具体含义、使用方法及注意事项
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
货品数据 | goods_list | List<Map<String, Object>> | 是 | 货品数据 | |
总数 | total_count | Int | 11 | 是 | 查询条件总单据数 |
goods_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 平台货品唯一键 | rec_id | Int | 11 | 是 | 平台货品唯一键 |
| 店铺id | shop_id | Int | 11 | 是 | 店铺id |
| 店铺编号 | shop_no | String | 20 | 是 | 店铺编号 |
| 店铺名称 | shop_name | String | 40 | 是 | 店铺名称 |
| 货品名称 | goods_name | String | 255 | 是 | 平台货品名称 |
| 规格名称 | spec_name | String | 100 | 是 | 平台规格名称 |
| 平台规格编码 | spec_outer_id | String | 40 | 是 | 平台规格编码 |
| 平台货品编号 | outer_id | String | 40 | 是 | 平台货品编号 |
| 货品ID | goods_id | String | 40 | 是 | 平台货品ID |
| 规格ID | spec_id | String | 40 | 是 | 平台规格ID |
| 活动状态 | is_deleted | Int | 1 | 是 | 0正常货品,1平台删除,2手工删除 |
| 价格 | price | Decimal(19,4) | 是 | 平台价格 | |
| 平台库存 | stock_num | Decimal(19,4) | 是 | 平台库存 | |
| 状态 | status | Int | 4 | 是 | 0删除,1在架,2下架 |
| 自动匹配 | is_auto_match | Int | 1 | 是 | 1自动匹配,0 手动匹配 |
| 系统货品 | match_target_type | Int | 1 | 是 | 0未指定,1单品,2组合装 |
| 平台id | platform_id | Int | 是 | 平台id,点击查看平台代码表 | |
| 占用库存 | hold_stock | Decimal(19,4) | 是 | 占用库存 | |
| 占用方式 | hold_stock_type | Int | 4 | 是 | 1拍下减库存 2付款减库存 |
自动上架 | is_auto_listing | bool | 1 | 是 | 是否自动上架 true:是 false:否 |
| 自动下架 | is_auto_delisting | bool | 1 | 是 | 是否自动下架 true:是 false:否 |
| 最后修改时间 | 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时返回为空字符串 |
| 平台类目id | cid | String | 40 | 是 | 平台类目id |
| 自动匹配的商家编码 | match_code | String | 40 | 是 | 如果是根据商家编码自动匹配的,那么这个字段记录了商家编码,可以是货品的编码+规格的编码 |
| 系统货品id | match_target_id | Int | 11 | 是 | match_target_type=1,这值是单品的主键,如果match_target_type=2,这值是组合装的主键 |
| 平台条码信息 | barcode | string | 11 | 是 | 平台上的条码,可能存在多个 用 , 号分隔 |
| 平台规格码 | spec_code | String | 40 | 是 | 平台规格码 |
| 平台sku属性串 | spec_sku_properties | String | 1024 | 是 | 平台sku属性串 |
| 创建时间 | created | String | 是 | 创建时间 | |
| 后台信息同步库存 | disable_syn_until | Int | 11 | 是 | 后台信息同步库存 |
| 停止同步原因 | disabled_reason | String | 255 | 是 | 停止同步原因 |
| 最后同步库存量 | last_syn_num | Decimal(19,4) | 是 | 最后同步库存量 | |
| 品牌id | brand_id | Int | 11 | 是 | 品牌id |
| 是否停止库存同步 | is_disable_syn | boolean | 1 | 是 | 是否停止库存同步 |
| 图片url | pic_url | String | 255 | 是 | 图片url |
| 库存变化时自增量 | stock_change_count | Int | 是 | 库存变化时自增量 | |
| 标记id | flag_id | Int | 是 | 标记id | |
| 标记名称 | flag_name | String | 是 | 标记名称 | |
| 货品编号 | goods_no | String | 是 | 系统货品编号 |
| JSON | {
"status": 100,
"message": "参数中必须包含起止时间"
} |