当前位置: API文档
suites_query.php(查询组合装)
1.1 接口描述:获取旺店通ERP中组合装界面的组合装资料 |
1.2 适用版本:客户端 V2.4.5.0及以上版本 |
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.5 注意事项:本接口如果不传start_time、end_time,则suite_no必须要传,如果start_time、end_time和suite_no都传了,则按照时间和商家编码的查询同时生效。 |
2.1 数据分析系统对接 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/suites_query.php |
正式环境 | https://api.wangdian.cn/openapi2/suites_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 | |
组合装商家编码 | suite_no | varchar | 40 | 否 | 代表组合装商品所有属性的唯一编码,用于系统组合装商品数据的获取,如果按照组合装商家编码查询,可以不传送开始时间和结束时间 |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 | |
页号 | page_no | int | 否 | 不传值默认从0页开始 | |
分类名称 | class_name | varchar | 32 | 否 | 分类名称 |
品牌名称 | brand_name | varchar | 32 | 否 | 品牌名称 |
是否停用 | deleted | varchar | 否 | 0未停用 1全量 不传本参数,输入值默认为0 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 11 | 是 | 符合条件的数据条数,用来分页 当page_no = 0时返回 |
组合装节点 | suites | data[] | 是 | (suite)数据节点,响应参数的1级数据节点,包含组合装所有属性信息的数据节点,节点下数据字段详见下述“suites”和"spec_list" |
suites
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
组合装主键 | suite_id | int | 11 | 是 | erp组合装表的主键 |
组合装商家编码 | suite_no | varchar | 40 | 是 | 代表组合装商品所有属性的唯一编码,用于系统组合装商品的区分 |
条形码 | barcode | varchar | 40 | 是 | 组合装条形码 |
组合装名称 | suite_name | varchar | 255 | 是 | 组合装名称 |
简称 | short_name | varchar | 255 | 是 | 组合装简称 |
分类名称 | class_name | varchar | 255 | 是 | 分类名称 |
品牌名称 | brand_name | varchar | 255 | 是 | 品牌名称 |
零售价 | retail_price | decimal | 19,4 | 是 | 零售价 |
批发价 | wholesale_price | decimal | 19,4 | 是 | 批发价 |
会员价 | member_price | decimal | 19,4 | 是 | 会员价 |
市场价 | market_price | decimal | 19,4 | 是 | 市场价 |
重量 | weight | decimal | 19,4 | 是 | 重量 |
基本单位 | unit_name | varchar | 20 | 是 | 基本单位 |
辅助单位 | unit_aux_name | varchar | 20 | 是 | 辅助单位 |
自定义属性1 | prop1 | varchar | 40 | 是 | 自定义属性1 |
自定义属性2 | prop2 | varchar | 40 | 是 | 自定义属性2 |
自定义属性3 | prop3 | varchar | 40 | 是 | 自定义属性3 |
自定义属性4 | prop4 | varchar | 40 | 是 | 自定义属性4 |
备注 | remark | varchar | 64 | 是 | 备注 |
大件属性 | large_split | tinyint | 4 | 是 | 组合装大件属性(仅支持手动拆分)0:非大件/1:普通大件/2:独立大件 |
标记 | flag_name | varchar | 40 | 是 | 标记 |
分类id | class_id | varchar | 11 | 是 | 分类 |
品牌id | brand_id | varchar | 11 | 是 | 品牌 |
平台货品数量 | plat_goods_count | smallint | 6 | 是 | 平台货品数量 |
平台有效货品数量 | plat_avail_count | smallint | 6 | 是 | 平台有效货品数量 |
是否自动计算 | is_auto_calc | tinyint | 1 | 是 | 重量等是否怎么由组合装的货品算出来 |
基本单位 | unit | varchar | 11 | 是 | 基本单位 |
辅助单位 | aux_unit | varchar | 11 | 是 | 辅助单位 |
是否打印组合装 | is_print_suite | tinyint | 4 | 是 | 0:组合装明细/1:组合装以及明细/2:组合装 |
标记 | flag_id | varchar | 11 | 是 | 标记 |
删除状态 | deleted | varchar | 11 | 是 | 删除状态 未删除=0 已删除>0 |
条码个数 | barcode_count | int | 11 | 是 | 条码个数 |
创建时间 | created | datetime | 是 | 创建时间 时间格式:yyyy-MM-dd HH:mm:ss | |
最后修改时间 | modified | datetime | 是 | 最后修改时间 时间格式:yyyy-MM-dd HH:mm:ss | |
单品节点 | specs_list | data[] | 是 | 响应参数的2级数据节点,包含sku所有属性信息的数据节点,节点下数据字段详见下述"specs_list" |
specs_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
组合装主键 | suite_id | int | 11 | 是 | erp组合装表的主键 |
单品商家编码 | spec_no | varchar | 40 | 是 | 代表所单品(sku)所有属性的编码,SPU和SKU概念介绍,单击这里 |
单品名称 | spec_name | varchar | 100 | 是 | 单品名称 |
条码 | barcode | varchar | 50 | 是 | 单品条形码 |
规格码 | spec_code | varchar | 40 | 是 | 规格码 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
货品编号 | goods_no | varchar | 40 | 是 | 代表SPU所有属性的编号,SPU和SKU概念介绍,单击这里 |
数量 | num | decimal | 19,4 | 是 | 单品数量 |
单品主键id | rec_id | varchar | 11 | 是 | 单品主键id |
规格id | spec_id | varchar | 11 | 是 | 规格id |
基本单位 | unit | varchar | 11 | 是 | 基本单位 |
删除状态 | deleted | tinyint | 4 | 是 | 删除状态,和goods_suite一致(0:正常 1:已删除) 2:特殊处理,该明细对应的单品库存变化时不进行库存同步 |
使用固定售价 | is_fixed_price | tinyint | 1 | 是 | 是否使用固定售价 0:否/1:是(固定售价是手动填写的金额,非固定售价按金额占比分摊) |
固定金额 | fixed_price | decimal | 19,4 | 是 | 组合装中单品的单价金额 |
金额占比 | ratio | decimal | 5,4 | 是 | 单品占组合装总价格的百分比 |
最后修改时间 | modified | datetime | 是 | 时间格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 时间格式:yyyy-MM-dd HH:mm:ss |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 2102, "message": "start_time和end_time为空或不是有效的时间格式[0000-00-00 00:00:00] " } |