当前位置: API文档
vip_api_goods_query.php(查询平台货品)
| 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.1 其他 |
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | https://openapitest.huice.com/openapi/vip_api_goods_query.php |
| 正式环境 | https://openapi.huice.com/openapi/vip_api_goods_query.php |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
| 接口账号 | appkey | String | 是 | 本开放 平台“自助对接”功能模块内自助申请,申请流程单击这里 | |
| 时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版APi服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
| 签名 | sign | String | 是 | APi输入参数签名结果,签名算法介绍单击这里 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
| 开始时间 | start_time | datetime | 是 | 按最后修改时间增量查询数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss | |
| 结束时间 | end_time | datetime | 是 | 按最后修改时间增量查询数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss | |
| 分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~1000,不传本参数,输入值默认为100,使用举例单击这里 | |
| 页号 | page_no | int | 否 | 页号,不传默认从0页开始 | |
| 店铺编号 | shop_id | varchar | 否 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置,查看路径ERP→设置→基本设置→店铺→店铺列表),用于创建指定店铺单据信息,测试环境店铺编号查看测试环境分配邮件。 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
| 错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
| 错误描述 | message | varchar | 255 | 是 | 错误描述 |
| 数据条数 | total_count | int | 10 | 否 | 数据总条数,用来分页 |
| 平台商品列表节点 | goods_list | data[ ] | 是 | 响应参数的级数据节点,包含当前页的库存管理信息的数据节点,节点下数据字段详见下述“goods_list”列表 |
| 名称 | 字段 | 类型 | 必须 | 描述 |
|---|---|---|---|---|
| 店铺id | shop_id | int(11) | 是 | |
| 平台货品id | api_goods_id | string | 是 | |
| 平台规格id | api_spec_id | string | 是 | |
| 平台货品表id | rec_id | bigint(20) | 是 | |
| 平台id | platform_id | int(11) | 是 | 点击查看平台ID详情 |
| 活动状态 | is_deleted | tinyint(4) | 是 | 0正常货品,1 删除, |
| 平台货品状态 | status | tinyint(4) | 是 | 0删除1在架2下架 |
| 平台货品编码 | outer_id | string | 是 | |
| 平台货品名称 | api_goods_name | string | 是 | |
| 平台规格名称 | api_spec_name | string | 是 | |
| 平台规格编码 | spec_outer_id | string | 是 | |
| 平台规格码 | spec_code | string | 是 | |
| 平台库存 | stock_num | decimal(19, 4) | 是 | |
| 匹配类型 | match_target_type | tinyint(4) | 是 | 0未匹配,1匹配单品商家编码,2匹配组合装商家编 |
| 匹配编码 | match_code | string | 是 | |
| 系统货品名称 | merchant_name | string | 是 | match_target_type=1时返回的为单品货品名称、match_target_type=2时返回的为组合装货品名称 |
| 系统规格名称 | merchant_code | string | 是 | match_target_type=1时返回的为单品规格名称、match_target_type=2时返回为“空” |
| 系统商家编码 | merchant_no | string | 是 | match_target_type=1时返回的为单品商家编码、match_target_type=2时返回的为组合装商家编码 |
| 系统商家编码主键id | match_target_id | string | 是 | 1是单品id,2是组合装id |
| 价格 | price | decimal(19, 4) | 是 | |
| 类目 | cid | string | 否 | |
| 图片链接 | pic_url | string | 是 | |
| 条码 | barcode | string | 否 | |
| 品牌id | brand_id | int(11) | 否 | |
| 最后修改时间 | modified | datetime | 是 |
5.请求示例
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
| JSON | {
"code": 2104,
"message": "start_time与end_time时间跨度不能超过最大范围 30天"
} |