当前位置: API文档

suites_query.php(查询组合装)

¥标准

1.接口说明

1.1 接口描述:获取ERP中组合装界面的组合装资料
1.2 适用版本:客户端 V2.4.0.5及以上版本
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都传了,则按照时间和商家编码的查询同时生效本接口如果不传start_time和end_time,则spec_no和goods_no必须传一个;当请求参数传了spec_no和goods_no其中一个  或者两个都传了的时候,start_time和end_time不生效。

2.调用场景

2.1 数据分析系统对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/suites_query.php
正式环境http://api.wangdian.cn/openapi2/suites_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
组合装商家编码suite_novarchar40代表组合装商品所有属性的唯一编码,用于系统组合装商品数据的获取,如果按照组合装商家编码查询,可以不传送开始时间和结束时间
分页大小page_sizeint
每页返回的数据条数,输入值范围1~40,不传本参数,输入值默认为40,使用举单击这里
页号page_noint
不传值默认从0页开始
分类名称class_namevarchar32分类名称
品牌名称brand_namevarchar32品牌名称

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint11符合条件的数据条数,用来分页 当page_no = 0时返回
组合装节点suitesdata[]
(suite)数据节点,响应参数的1级数据节点,包含组合装所有属性信息的数据节点,节点下数据字段详见下述“suites”和"spec_list"

   4.2 业务响应参数

   suites

名称字段类型长度
必须描述
组合装主键suite_idint11erp组合装表的主键
组合装商家编码suite_novarchar40代表组合装商品所有属性的唯一编码,用于系统组合装商品的区分
条码barcodevarchar40组合装条形码
组合装名称suite_namevarchar255组合装名称
简称short_namevarchar255组合装简称
分类名称class_namevarchar255分类名称
品牌名称brand_namevarchar255品牌名称
零售价retail_pricedecimal19,4零售价
批发价wholesale_pricedecimal19,4批发价
会员价member_pricedecimal19,4会员价
市场价market_pricedecimal19,4市场价
重量weightdecimal19,4重量
基本单位unit_namevarchar
20
基本单位
辅助单位unit_aux_namevarchar
20
辅助单位
自定义属性1prop1varchar40自定义属性1
自定义属性2prop2varchar40自定义属性2
自定义属性3prop3varchar40自定义属性3
自定义属性4prop4varchar40自定义属性4
备注remarkvarchar64备注
大件属性large_splittinyint4组合装大件属性(仅支持手动拆分)0:非大件/1:普通大件/2:独立大件
标记flag_namevarchar
40
标记
条码个数barcode_countint11条码个数
创建时间createddatetime
创建时间’0000-00-00 00:00:00′
最后修改时间modifieddatetime
最后修改时间
单品节点specs_listdata[]
响应参数的2级数据节点,包含sku所有属性信息的数据节点,节点下数据字段详见下述"spec_list"

  specs_list

名称字段类型长度
必须描述
组合装主键suite_idint11erp组合装表的主键
单品商家编码spec_novarchar40代表所单品(sku)所有属性的编码,SPU和SKU概念介绍,单击这里
单品名称spec_namevarchar100单品名称
条码barcodevarchar50单品条形码
规格码spec_codevarchar40规格码
货品名称goods_namevarchar255货品名称
货品编号goods_novarchar40代表SPU所有属性的编号,SPU和SKU概念介绍,单击这里
数量numdecimal
19,4
单品数量
使用固定售价is_fixed_pricetinyint1是否使用固定售价 0:否/1:是(固定售价是手动填写的金额,非固定售价按金额占比分摊)
固定金额fixed_pricedecimal19,4组合装中单品的单价金额
金额占比ratiodecimal5,4单品占组合装总价格的百分比
最后修改时间modifieddatetime
格式:YYYY-MM-DD HH:MM:SS
创建时间createddatetime
格式:YYYY-MM-DD HH:MM:SS

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->appsecret = '12345';
    
    $c->sid = 'apidevnew2';
    $c->appkey = 'mytest';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/suites_query.php';


    //添加查询参数
    $c->putApiParam('page_size', '10');
    $c->putApiParam('suite_no','CE001');
    $json = $c->wdtOpenApi();
    print_r($json);
    
?>
JAVA

C#

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "total_count": 1,
    "suites": [{
        "suite_id": "38",
        "suite_no": "ZX001001",
        "barcode": "ZX001001",
        "suite_name": "测试组合装",
        "short_name": "测试组合装",
        "class_name": "女装",
        "brand_name": "嫲嫲团",
        "retail_price": "60.0000",
        "wholesale_price": "0.0000",
        "member_price": "0.0000",
        "market_price": "0.0000",
        "weight": "0.0000",
        "unit_name": "件",
        "unit_aux_name": null,
        "prop1": "",
        "prop2": "",
        "prop3": "",
        "prop4": "",
        "remark": "",
        "large_split": "0",
        "flag_name": null,
        "barcode_count": "0",
        "created": "0000-00-00 00:00:00",
        "modified": "2019-05-08 09:50:23",
        "specs_list": [{
            "suite_id": "38",
            "spec_no": "ZZ001001",
            "spec_name": "粉色; ",
            "barcode": "ZZ001001",
            "spec_code": "1005084",
            "goods_name": "测试组合装",
            "goods_no": "ZZ001",
            "num": "1.0000",
            "fixed_price": "60.0000",
            "ratio": "0.5000",
            "is_fixed_price": "0",
            "modified": "2019-05-08 09:50:23",
            "created": "0000-00-00 00:00:00"
        }, {
            "suite_id": "38",
            "spec_no": "ZZXX001001",
            "spec_name": "白色",
            "barcode": "ZZXX001001",
            "spec_code": "1005084",
            "goods_name": "测试组合装",
            "goods_no": "ZZXX001",
            "num": "1.0000",
            "fixed_price": "60.0000",
            "ratio": "0.5000",
            "is_fixed_price": "0",
            "modified": "2019-05-08 09:50:23",
            "created": "0000-00-00 00:00:00"
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 2102,
    "message": "start_time和end_time为空或不是有效的时间格式[0000-00-00 00:00:00] "
}



常用工具