当前位置: API文档
goods_query.php(查询货品档案)
1.1 接口描述:获取旺店通ERP的货品档案资料,“货品档案”其他系统称为“物料档案”“商品档案”等 |
1.2 适用版本:客户端 V2.4.5.1及以上版本 |
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://sandbox.wangdian.cn/openapi2/goods_query.php |
正式环境 | https://api.wangdian.cn/openapi2/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概念介绍,单击这里 |
品牌编号 | brand_no | varchar | 32 | 否 | 品牌编号 |
分类名称 | class_name | varchar | 32 | 否 | 类别名称 |
条码 | 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 | 是 | 简称 |
货品别名 | alias | varchar | 255 | 是 | 货品别名 |
货品类别 | goods_type | tinyint | 1 | 是 | 货品类别 0:其它, 1:销售货品, 2:原材料, 3:包装物, 4:周转材料, 5:虚拟商品, 6:固定资产,7:保修配件 8:虚拟代发货品 |
规格数 | spec_count | int | 11 | 是 | 规格数 |
拼音 | pinyin | varchar | 40 | 是 | 拼音 |
品牌编号 | brand_no | varchar | 32 | 是 | 品牌编号 |
品牌 | brand_name | varchar | 64 | 是 | 品牌名称 |
备注 | remark | varchar | 512 | 是 | 备注 |
自定义属性1 | prop1 | varchar | 255 | 是 | 自定义属性1 |
自定义属性2 | prop2 | varchar | 255 | 是 | 自定义属性2 |
自定义属性3 | prop3 | varchar | 255 | 是 | 自定义属性3 |
自定义属性4 | prop4 | varchar | 255 | 是 | 自定义属性4 |
自定义属性5 | prop5 | varchar | 255 | 是 | 自定义属性5 |
自定义属性6 | prop6 | varchar | 255 | 是 | 自定义属性6 |
产地 | origin | varchar | 64 | 是 | 产地 |
分类id | class_id | varchar | 64 | 是 | 分类id |
分类 | class_name | varchar | 64 | 是 | 分类名称 |
品牌id | brand_id | varchar | 11 | 是 | 品牌ID |
基本单位id | unit | varchar | 11 | 是 | 基本单位id |
辅助单位id | aux_unit | varchar | 11 | 是 | 辅助单位id |
标记 | flag_id | varchar | 11 | 是 | 标记 |
属性 | properties | varchar | 1024 | 是 | 属性 |
版本号 | version_id | varchar | 11 | 是 | 版本号,用来检查同时修改的 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss | |
基本单位 | unit_name | varchar | 20 | 是 | 基本单位名称 |
辅助单位 | aux_unit_name | varchar | 20 | 是 | 辅助单位名称 |
标记名称 | flag_name | varchar | 32 | 是 | 标记名称 |
创建时间 | goods_created | datetime | 是 | 格式:yyyy-MM-dd HH:mm:ss。ERP客户端需升级至V2.3.8.6及以上版本可获取此字段 | |
最后修改时间 | goods_modified | datetime | 是 | 格式:yyyy-MM-dd HH:mm:ss | |
是否已删除 | deleted | int | 11 | 是 | 是否已删除: 0:未删除 >0代表已删除 |
单品节点 | spec_list | data[] | 是 | 响应参数的2级数据节点,包含sku所有属性信息的数据节点,节点下数据字段详见下述"spec_list" |
spec_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
规格ID | spec_id | varchar | 40 | 是 | 规格ID |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍,单击这里 |
规格码 | spec_code | varchar | 40 | 是 | 规格码 |
主条码 | barcode | varchar | 50 | 是 | 主条码,单品下如果有多个条码,会随机返回其中一条条码 |
规格名称 | spec_name | varchar | 100 | 是 | 规格名称 |
货品ID | goods_id | int | 11 | 是 | 货品ID |
最低价 | lowest_price | decimal | 19,4 | 是 | 最低价 |
零售价 | retail_price | decimal | 19,4 | 是 | 零售价 |
批发价 | wholesale_price | decimal | 19,4 | 是 | 批发价 |
会员价 | member_price | decimal | 19,4 | 是 | 会员价 |
市场价 | market_price | decimal | 19,4 | 是 | 市场价 |
自定义价格1 | custom_price1 | decimal | 19,4 | 是 | 自定义价格1 |
自定义价格2 | custom_price2 | decimal | 19,4 | 是 | 自定义价格2 |
销售积分 | sale_score | int | 11 | 是 | 销售积分 |
打包积分 | pack_score | int | 11 | 是 | 打包积分 |
拣货积分 | pick_score | int | 11 | 是 | 拣货积分 |
有效期天数 | validity_days | int | 11 | 是 | 保质期 |
最佳销售天数 | sales_days | int | 11 | 是 | 最佳销售天数 |
最佳收获天数 | receive_days | int | 11 | 是 | 最佳收获天数 |
重量 | weight | decimal | 19,4 | 是 | 重量 |
长 | length | decimal | 19,4 | 是 | 长(CM) |
宽 | width | decimal | 19,4 | 是 | 宽(CM) |
高 | height | decimal | 19,4 | 是 | 高(CM) |
是否启用序列号 | is_sn_enable | tinyint | 4 | 是 | 0不启用序列号 1强序列号 2弱序列号 |
是否允许负库存 | is_allow_neg_stock | tinyint | 1 | 是 | 0(不允许负库存);1(允许负库存) |
是否出库不验货 | is_not_need_examine | tinyint | 1 | 是 | 0(出库不验货);1(出库必须验货) |
是否允许0成本 | is_zero_cost | tinyint | 1 | 是 | 0(不允许0成本);1(允许0成本) |
是否允许低于成本价 | is_lower_cost | tinyint | 1 | 是 | 0(不允许低于成本价);1(允许低于成本价) |
是否航空禁运 | is_not_use_air | tinyint | 1 | 是 | 0(航空不禁运) 1(航空禁运); |
税率 | tax_rate | decimal | 8,4 | 是 | 税率 |
大件类别 | large_type | tinyint | 1 | 是 | 0非大件1普通大件2独立大件 |
备注 | remark | varchar | 512 | 是 | 备注 |
创建时间 | spec_created | datetime | 是 | 格式:YYYY-MM-DD HH:MM:SS | |
最后修改时间 | spec_modified | datetime | 是 | 格式:YYYY-MM-DD HH:MM:SS | |
自定义1 | prop1 | varchar | 255 | 是 | 自定义1 |
自定义2 | prop2 | varchar | 255 | 是 | 自定义2 |
自定义3 | prop3 | varchar | 255 | 是 | 自定义3 |
自定义4 | prop4 | varchar | 255 | 是 | 自定义4 |
自定义5 | prop5 | varchar | 255 | 是 | 自定义5 |
自定义6 | prop6 | varchar | 255 | 是 | 自定义6 |
图片 | img_url | varchar | 1024 | 是 | 图片url |
税务编码 | tax_code_id | varchar | 11 | 是 | 关联税务表税务编码 |
同一批次出库 | is_single_batch | tinyint | 4 | 是 | 是否启用同一批次, 0,不使用同一批次,1,使用同一批次 |
水洗标 | washing_label | varchar | 40 | 是 | 水洗标 |
基本单位 | unit | varchar | 11 | 是 | 基本单位 |
辅助单位 | aux_unit | varchar | 11 | 是 | 辅助单位 |
标记 | flag_id | varchar | 11 | 是 | 标记 |
图片在外部空间的key | img_key | varchar | 100 | 是 | 看图片在外部空间的key 比如说 云盘的一个 外链 |
条码个数 | barcode_count | smallint | 6 | 是 | 条码个数 |
平台货品数量 | plat_spec_count | smallint | 6 | 是 | 平台货品数量(不包含删除的) |
sn自增数 | postfix_val | varchar | 11 | 是 | sn自增数 |
最后日期 | last_date | date | 是 | 最后日期 格式:yyyy-MM-dd | |
补货方式 | replenish_type | varchar | 11 | 是 | 补货方式 0持续补货 1不补货 2低于警戒库存补货 |
畅销品 | is_popular | varchar | 11 | 是 | 是否畅销 0非畅销 1畅销 |
备注换货匹配码 | replace_no | varchar | 40 | 是 | 备注换货匹配码 |
单品标记二进制位 | spec_mask | varchar | 11 | 是 | 单品标记二进制位 1同款备注换货虚拟规格 2是否在备注换货界面展示 4递交自动生成货品 |
同款备注换货 | replace_proportion | varchar | 11 | 是 | 同款备注换货--虚拟货品换货比例 |
扩展字段 | extra_3 | varchar | 40 | 是 | 扩展字段 |
税务编码 | tax_code | varchar | 32 | 是 | 税务编码 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss | |
基本单位 | spec_unit_name | varchar | 20 | 是 | 基本单位名称 |
辅助单位 | spec_aux_unit_name | varchar | 20 | 是 | 辅助单位名称 |
是否已删除 | deleted | int | 11 | 是 | 是否已删除:0:未删除 >0代表已删除 |
条码列表 | barcode_list | data[ ] | 是 | 条码详细信息 |
barcode_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
货品ID | goods_id | varchar | 11 | 是 | 货品ID |
规格ID | spec_id | varchar | 40 | 是 | 规格ID |
条码 | barcode | varchar | 255 | 是 | 条码信息 |
类型 | type | varchar | 1 | 是 | target_id的类型 1普通规格 2组合装 |
是否主条码 | is_master | varchar | 1 | 是 | 是否为主条码 0 否 1 是 |
扫码一次对应出库数量 | out_target_num | varchar | 11 | 是 | 扫码一次对应出库数量 |
扫码一次对应入库货品数量 | target_num | varchar | 11 | 是 | 扫码一次对应入库货品数量 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": "20", "message": "请求范围过宽,请增加请求参数条件过滤" } |