当前位置: API文档
goods_query.php(查询货品档案)
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.1 自研商城、SCM、SRM、财务系统、SAP等系统的对接 |
环境 | HTTP地址 |
---|---|
测试环境 | https://openapitest.huice.com/openapi/goods_query.php |
正式环境 | https://openapi.huice.com/openapi/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输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
商家编码 | spec_no | varchar | 40 | 否 | 代表单品(SKU)所有属性的唯一编码,用于获取指定的系统单品的数据,SKU概念介绍,单击这里 |
货品编号 | goods_no | varchar | 40 | 否 | 代表货品(SPU)所有属性的唯一编号,用于指定获取系统货品的数据,SPU概念介绍,单击这里 |
条码 | barcode | varchar | 64 | 否 | 条码 |
开始时间 | start_time | datetime | 是 | 按最后修改时间增量查询数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss | |
结束时间 | end_time | datetime | 是 | 按最后修改时间增量查询数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss | |
已删除货品 | deleted | tinyint | 4 | 否 | 默认为0, 0:只返回未删除货品 1:返回未删除和已删除货品 |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 | |
页号 | page_no | int | 否 | 页号,不传默认从0页开始 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 11 | 是 | 符合条件的数据条数,用来分页 当page_no = 0时返回 |
货品节点 | goods_list | data[] | 是 | 响应参数的1级数据节点,包含SPU所有属性信息的数据节点,节点下数据字段详见下述“goods_list”和"spec_list" |
goods_list | |||||
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
货品ID | goods_id | int | 11 | 是 | 货品表主键 |
货品编号 | goods_no | varchar | 40 | 是 | 代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍,单击这里 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
货品简称 | short_name | varchar | 255 | 货品简称 | |
规格数 | spec_count | int | 11 | 是 | 规格数 |
品牌 | brand_name | varchar | 64 | 是 | 品牌名称 |
备注 | remark | varchar | 512 | 是 | 备注 |
标记 | flag_id | varchar | 11 | 是 | 标记 |
版本号 | version_id | varchar | 11 | 是 | 版本号,用来检查同时修改的 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss | |
标记名称 | flag_name | varchar | 32 | 是 | 标记名称 |
是否已删除 | deleted | int | 11 | 是 | 是否已删除: 0:未删除 >0代表已删除 |
货品分类id | goods_category_id | int | 否 | ||
货品分类名称 | category_name | varchar | 否 | 为空时null | |
自定义属性1 | prop1 | varchar | 255 | 否 | 自定义属性1 |
自定义属性2 | prop2 | varchar | 255 | 否 | 自定义属性2 |
自定义属性2 | prop3 | varchar | 255 | 否 | 自定义属性3 |
自定义属性4 | prop4 | varchar | 255 | 否 | 自定义属性4 |
自定义属性5 | prop5 | varchar | 255 | 否 | 自定义属性5 |
自定义属性6 | prop6 | varchar | 255 | 否 | 自定义属性6 |
单品节点 | spec_list | data[] | 是 | 响应参数的2级数据节点,包含sku所有属性信息的数据节点,节点下数据字段详见下述"spec_list" | |
spec_list | |||||
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
规格ID | spec_id | varchar | 40 | 是 | 规格ID |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍,单击这里 |
规格名称 | spec_name | varchar | 100 | 是 | 规格名称 |
货品ID | goods_id | int | 11 | 是 | 货品ID |
零售价 | retail_price | decimal | 19,4 | 是 | 零售价 |
批发价 | wholesale_price | decimal | 19,4 | 是 | 批发价 |
重量 | weight | decimal | 19,4 | 是 | 重量 |
长 | length | decimal | 19,4 | 是 | 长(CM) |
宽 | width | decimal | 19,4 | 是 | 宽(CM) |
高 | height | decimal | 19,4 | 是 | 高(CM) |
备注 | remark | varchar | 512 | 是 | 备注 |
创建时间 | spec_created | datetime | 是 | 格式:YYYY-MM-DD HH:MM:SS | |
最后修改时间 | spec_modified | datetime | 是 | 格式:YYYY-MM-DD HH:MM:SS | |
基本单位 | unit | varchar | 11 | 是 | 基本单位 |
辅助单位 | aux_unit | varchar | 11 | 是 | 辅助单位 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss | |
是否已删除 | deleted | int | 11 | 是 | 是否已删除:0:未删除 >0代表已删除 |
图片 | img_url | varchar | 1024 | 规格图片 | |
供应商编码 | provider_no | varchar | 64 | 供应商编码 | |
供应商名称 | provider_name | varchar | 64 | 供应商名称 | |
供应商id | provider_id | long | 供应商id | ||
成本价 | ref_cost_price | decimal | 19,4 | 否 | 固定成本价 为0 |
规格自定义属性1 | prop1 | varchar | 255 | 否 | 规格自定义属性1 |
规格自定义属性2 | prop2 | varchar | 255 | 否 | 规格自定义属性2 |
规格自定义属性2 | prop3 | varchar | 255 | 否 | 规格自定义属性3 |
规格自定义属性4 | prop4 | varchar | 255 | 否 | 规格自定义属性4 |
规格自定义属性5 | prop5 | varchar | 255 | 否 | 规格自定义属性5 |
规格自定义属性6 | prop6 | varchar | 255 | 否 | 规格自定义属性6 |