当前位置: API文档

vip_api_goods_query.php(查询平台货品)

¥增值

1.接口说明

   1.1 接口描述:获取ERP的平台货品信息
   1.2 适用版本:网页版
   1.3 增量获取:按照平台货品的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。
   1.4 时间跨度:start_time和end_time最大跨度为30天。开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。
  1.5注意事项:权限校验:【店铺、仓库权限】

为了达到保护用户隐私数据安全的目的,本接口不返回淘系、拼多多及系统供销平台数据相关平台规则点击这里淘系及系统供销平台数据获取办法点击这里拼多多请自行对接平台获取

本接口中涉及到用户隐私的字段数据仅有自有平台及线下平台订单返回。

2.调用场景

   2.1 其他

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://openapitest.huice.com/openapi/vip_api_goods_query.php
正式环境https://openapi.huice.com/openapi/vip_api_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 业务请求参数

名称字段类型长度必须描述
开始时间start_timedatetime
按最后修改时间增量查询数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss
结束时间end_timedatetime
按最后修改时间增量查询数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss
分页大小page_sizeint
每页返回的数据条数,输入值范围1~1000,不传本参数,输入值默认为100,使用举例单击这里
页号page_noint
页号,不传默认从0页开始
店铺编号shop_idvarchar
代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置,查看路径ERP→设置→基本设置→店铺→店铺列表),用于创建指定店铺单据信息,测试环境店铺编号查看测试环境分配邮件。

4.响应参数

   4.1 公共响应参数

名称字段类型长度必须描述
错误码codeint40状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint10数据总条数,用来分页
平台商品列表节点goods_listdata[ ]
响应参数的级数据节点,包含当前页的库存管理信息的数据节点,节点下数据字段详见下述“goods_list”列表

   4.2 业务响应参数

名称
 字段类型必须描述
店铺idshop_idint(11)
平台货品idapi_goods_idstring
平台规格idapi_spec_idstring
平台货品表idrec_idbigint(20)
平台idplatform_idint(11)点击查看平台ID详情
活动状态is_deletedtinyint(4)0正常货品,1 删除, 
平台货品状态statustinyint(4)0删除1在架2下架
平台货品编码outer_idstring
平台货品名称api_goods_namestring
平台规格名称api_spec_namestring
平台规格编码spec_outer_idstring
平台规格码spec_codestring
平台库存stock_numdecimal(19, 4)
匹配类型match_target_typetinyint(4)0未匹配,1匹配单品商家编码,2匹配组合装商家编
匹配编码match_codestring
系统货品名称merchant_namestringmatch_target_type=1时返回的为单品货品名称、match_target_type=2时返回的为组合装货品名称
系统规格名称merchant_codestringmatch_target_type=1时返回的为单品规格名称、match_target_type=2时返回为“空”
系统商家编码merchant_nostringmatch_target_type=1时返回的为单品商家编码、match_target_type=2时返回的为组合装商家编码
系统商家编码主键idmatch_target_idstring1是单品id,2是组合装id
价格pricedecimal(19, 4)
类目cidstring
图片链接pic_urlstring
条码barcodestring
品牌idbrand_idint(11)
最后修改时间modifieddatetime

5.请求示例

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

    //添加查询参数
    $c->putApiParam('start_time','2019-01-01 00:00:00');
    $c->putApiParam('end_time','2019-01-30 00:00:00');
    $c->putApiParam('page_no', '0');
    $c->putApiParam('page_size','10');
    $json = $c->wdtOpenApi();
    var_dump($json);
    
?>
JAvA

C#

6.响应示例

   6.1 正常响应示例 

JSON
{
	"code": 0,
	"message": "",
	"total_count": 192,
	"goods_list": [{
		"shop_id": "266",
		"api_goods_id": "2506100000016670",
		"api_spec_id": "2506100000016730",
		"rec_id": "2705524893792862225",
		"platform_id": 127,
		"is_deleted": 0,
		"status": 2,
		"outer_id": "2506100000016670",
		"api_goods_name": "菲力牛排-多规格",
		"api_spec_name": "【爆款推荐】M3眼肉牛排1.5KG_3kg",
		"spec_outer_id": "347",
		"spec_code": "347",
		"stock_num": null,
		"match_target_type": 0,
		"match_code": "",
		"merchant_name": null,
		"merchant_code": null,
		"merchant_no": null,
		"match_target_id": "0",
		"price": "0.0000",
		"cid": "",
		"pic_url": "https:\/\/ody-offline-product.obs.cn-east-2.myhuaweicloud.com\/dev\/ouser-web\/1749609750275_60.36053469495526_fdf0fc16-445f-452e-9c00-1555c3b09dd7.jpg",
		"barcode": "",
		"brand_id": null,
		"class_id_path": null,
		"modified": "2025-06-11 10:45:02"
	}]
}

   6.2 异常响应示例

JSON
{
    "code": 2104,
    "message": "start_time与end_time时间跨度不能超过最大范围 30天"
}



常用工具