当前位置: API文档

goods_query.php(查询货品档案)

¥标准

1.接口说明

   1.1 接口描述:获取旺店通ERP的货品档案资料,“货品档案”其他系统称为“物料档案”“商品档案”等
   1.2 适用版本:网页版
   1.3 增量获取:按照旺店通ERP内货品档案最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件,返回的结果不包含在旺店通ERP货品档案已停用的货品数据。
   1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。
   1.4 注意事项:本接口如果不传start_time和end_time,则spec_no和goods_no必须传一个;当请求参数传了spec_no和goods_no其中一个或者两个都传了的时候,start_time和end_time参数不生效。

2.调用场景

2.1 自研商城、SCM、SRM、财务系统、SAP等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://openapitest.huice.com/openapi/goods_query.php
正式环境https://openapi.huice.com/openapi/goods_query.php

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度
必须描述
商家编码spec_novarchar255代表单品(SKU)所有属性的唯一编码,用于获取指定的系统单品的数据,SKU概念介绍,单击这里
货品编号goods_novarchar40代表货品(SPU)所有属性的唯一编号,用于指定获取系统货品的数据,SPU概念介绍,单击这里
条码barcodevarchar50条码
开始时间start_timetimestamp
按最后修改时间增量查询数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss
结束时间end_timetimestamp
按最后修改时间增量查询数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss
是否隐藏删除数据
hide_deletedint
默认为0, 0:返回未删除和已删除货品1:只返回未删除货品  
分页大小page_size     int
每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里
页号page_noint
页号,不传默认从0页开始

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint11符合条件的数据条数,用来分页 当page_no = 0时返回
货品节点goods_listdata[]
响应参数的1级数据节点,包含SPU所有属性信息的数据节点,节点下数据字段详见下述“goods_list”和"spec_list"

  4.2 业务响应参数

名称
字段类型长度必须描述
货品IDgoods_idbigint
货品表主键
货品编号goods_novarchar255代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍,单击这里
货品名称goods_namevarchar255货品名称
货品简称short_namevarchar255
货品简称
规格数spec_countint11规格数
品牌名称brand_namevarchar256
品牌名称
品牌编码

brand_code

varchar128
品牌编码
最后修改时间modifiedtimestamp
最后修改时间  格式:yyyy-MM-dd HH:mm:ss
创建时间createdtimestamp
创建时间  格式:yyyy-MM-dd HH:mm:ss
是否已删除 deletedint 
是否已删除: 0:未删除  >0代表已删除 
货品分类idgoods_category_idbigint
货品分类id
货品分类名称category_namevarchar
货品分类名称
货品类型goods_typetinyint

 1成品、2半成品、3原料、4包装材料、5辅料、6资产。默认值为:成品
品牌id brandIdbigint

品牌id
自定义属性1prop1     varchar255自定义属性1      
自定义属性2prop2varchar255自定义属性2
自定义属性2prop3varchar255自定义属性3
自定义属性4prop4varchar255自定义属性4
自定义属性5prop5varchar255自定义属性5
自定义属性6prop6varchar255自定义属性6
单品节点spec_listdata[]
响应参数的2级数据节点,包含sku所有属性信息的数据节点,节点下数据字段详见下述"spec_list"

 spec_list

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

bigint


规格ID
商家编码spec_novarchar255代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍,单击这里
规格名称spec_namevarchar255规格名称
规格简称short_namevarchar

255

规格简称
条码barcodevarchar50条码
货品IDgoods_idint11货品ID
零售价retail_pricedecimal 19,4零售价
批发价wholesale_pricedecimal19,4批发价
重量weightdecimal19,4重量
lengthdecimal19,4长(CM)
widthdecimal19,4宽(CM)
heightdecimal19,4高(CM)
单位unitbigint
单位id
单位名称unit_namevarchar256
单位名称
辅助单位aux_unitbigint
辅助单位
最后修改时间modified           timestamp
最后修改时间    格式:yyyy-MM-dd HH:mm:ss
创建时间createdtimestamp
创建时间  格式:yyyy-MM-dd HH:mm:ss
是否已删除 deleted int 
是否已删除:0:未删除    >0代表已删除
图片img_urlvarchar1024规格图片
供应商编码provider_novarchar64
供应商编码
供应商名称provider_namevarchar64
供应商名称
供应商idprovider_idbigint


供应商id
成本价ref_cost_pricedecimal19,4固定成本价 为0 
规格的编号spec_codevarchar255
规格的编号,Y当前都为空
税率taxRatevarchar32
税率
规格自定义属性1prop1       varchar255规格自定义属性1   
规格自定义属性2prop2   varchar255规格自定义属性2      
规格自定义属性2prop3varchar255规格自定义属性3
规格自定义属性4prop4varchar255规格自定义属性4
规格自定义属性5prop5varchar255规格自定义属性5
规格自定义属性6prop6varchar255规格自定义属性6
附件file_url_listdata[]

附件,字符串格式返回

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'https://openapitest.huice.com/openapi/goods_query.php';

    //添加查询参数
    $c->putApiParam('start_time','2018-08-01 00:00:00');
    $c->putApiParam('end_time','2018-08-11 00:00:00');
    $json = $c->wdtOpenApi();
    var_dump($json);
    
?>
JAVA

C#

python

6.响应示例

   6.1 正常响应示例 

JSON
{
	"code": 0,
	"message": "",
	"total_count": 1,
	"goods_list": [{
		"goods_id": "2738416749937426441",
		"goods_no": "1005413",
		"goods_name": "茂名 东东蛋 AAA鲜鸡蛋30枚箱(只发广东地区)",
		"short_name": "",
		"goods_type": 0,
		"brand_name": "",
		"brand_id": "0",
		"class_name": "",
		"spec_count": 1,
		"deleted": 0,
		"modified": "2025-10-09 10:05:19",
		"created": "2025-09-09 14:10:30",
		"goods_category_id": "0",
		"category_name": "",
		"prop1": "",
		"prop2": "",
		"prop3": "",
		"prop4": "",
		"prop5": "",
		"prop6": "",
		"brand_code": "",
		"remark": "",
		"goods_status": 0,
		"spec_list": [{
			"spec_id": "2738416752131047433",
			"goods_id": "2738416749937426441",
			"spec_name": "无",
			"spec_no": "6976588640058",
			"spec_code": "",
			"retail_price": "79.9000",
			"wholesale_price": "0.0000",
			"weight": "0.0000",
			"length": "0.0000",
			"width": "0.0000",
			"height": "0.0000",
			"unit": "0",
			"unit_name": "",
			"aux_unit": 0,
			"deleted": 0,
			"img_url": "https:\/\/szbyjt.oss-cn-shenzhen.aliyuncs.com\/2025\/09\/8ca61237ce43436cb95b8d15665b4729.jpg,2025\/09\/3e3f1b7d3a3c4239b344d04717c9c2ee.jpg,2025\/09\/cc8819af9b8741cb943d01a05c232506.jpg,2025\/09\/a9adaf31f55c43559a1605a144807454.jpg,2025\/09\/e74309049e484cbab49eb6536b1288d7.jpg",
			"modified": "2025-09-09 14:10:31",
			"created": "2025-09-09 14:10:31",
			"provider_id": "0",
			"provider_no": "",
			"provider_name": "",
			"ref_cost_price": "49.9000",
			"prop1": "",
			"prop2": "",
			"prop3": "",
			"prop4": "",
			"prop5": "",
			"prop6": "",
			"file_url_list": [],
			"short_name": "",
			"barcode": "",
			"tax_rate": "0.0000",
			"remark": "",
			"goods_status": 0
		}]
	}]
}

   6.2 异常响应示例

JSON
{
    "code": "20",
    "message": "请求范围过宽,请增加请求参数条件过滤"
}



常用工具