获取自定义区模板列表

获取自定义区模板列表, 商家在快手云打印系统https://cloudprint.kwaixiaodian.com 进行模板设计,然后通过此接口获取模板列表。

如下模板示例:

1.请求参数:

请求URL:

POST https://kf.fw199.com/gateway/ks/express/custom/tempate/list/query

参数名称 参数类型 是否必须 示例值 参数描述
appid String 合作伙伴AppId
timestamp String 1657525936 当前Unix时间戳,秒
seller_nick String 38173182 快手的店铺账号,对应蜂巢授权返回seller_nick字段
sign String

业务参数

参数名称 参数类型 是否必须 示例值 参数描述
standardTemplateCode String ST1000 标准模板code, 可通过此接口获取https://doc.fw199.com/docs/h7b/ks-ebill-template
type int 1 查询类型,(1:商家自定义模板;2:ISV预设自定义模板;3:商家+ISV全部自定义模板)

2. 请求示例代码(Java)

    /**
     *  快手获取自定义区模板列表
     * @throws Exception
     */
    @Test
    public void ExpressCustomTempateListQuery() throws Exception {

        String sellerNick = Config.KSSellerNick ;
        Map<String, String> data = new HashMap();
        data.put("appid",  Config.AppId);
        data.put("seller_nick", sellerNick);

        Long timestamp = System.currentTimeMillis();
        data.put("timestamp", timestamp.toString());
        data.put("standardTemplateCode","EBSTO6" );
        data.put("type","3");
        // 参数签名
        data.put("sign", Utils.Sign(data, Config.AppSecret));
        String result = Utils.doHttpRequest(Config.KS_OPEN_EXPRESS_CUSTOM_TEMPATE_LIST_QUERY, data);
        System.out.println("result:"+result);
    }

3. 返回结果

返回结果如下

{
  "code": 0,
  "message": "ok",
  "data": [
    {
      "customTemplateCode": "EBCTO480447",
      "customTemplateName": "yd-1联单",
      "customTemplateUrl": "https://u1-401.ecukwai.com/kos/nlav11586/template/custom/EBCT-EBCTO480447.xml",
      "expressCompanyCode": "YUNDA",
      "expressCompanyName": "",
      "placeholderKeys": ["remark", "skuname"],
      "standardTemplateCode": "EBSTO6",
      "type": 1
    }
  ]
}

4. 返回字段说明

返回code为0表示成功, 非0为失败,失败时message会有失败原因。data对象中的字段说明如下:

字段 类型 说明
customTemplateName String 自定义模板名称
customTemplateCode String 编码
standardTemplateCode String 标准模板编码
customTemplateUrl String 自定义模板url
expressCompanyName String 物流公司名称
type Integer 类型(1:商家自定义模板;2:ISV预设自定义模板)
expressCompanyCode String 物流公司编码
placeholderKeys List 自定义模板中数据(data)的一级占位符名称的集合。 例1:模板中包含名称占位符<%=data.name%>,年龄占位符<%=data.age%>,本参数返回[“name”, “age”]; 例2:模板中包含如下占位符,<%=data.person.name%>,<%=data.person.age%>,<%=data.remark%>,本参数返回[“person”, “remark”]
文档更新时间: 2024-09-05 15:05   作者:admin