跳转到内容
返回官网

获取自定义区模板列表

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

如下模板示例:

m_5adf698bdd8266fc0e8ca48441f6172b_r_5049348

一、请求参数

请求URL:

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

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

业务参数

参数名称参数类型是否必须示例值参数描述
standardTemplateCodeStringST1000标准模板code, 可通过此接口获取ks-ebill-template
typeint1查询类型,(1:商家自定义模板;2:ISV预设自定义模板;3:商家+ISV全部自定义模板)

二、请求示例代码

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);
}

三、返回结果

返回结果如下

{
"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
}
]
}

四、返回字段说明

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

字段类型说明
customTemplateNameString自定义模板名称
customTemplateCodeString编码
standardTemplateCodeString标准模板编码
customTemplateUrlString自定义模板url
expressCompanyNameString物流公司名称
typeInteger类型(1:商家自定义模板;2:ISV预设自定义模板)
expressCompanyCodeString物流公司编码
placeholderKeysList自定义模板中数据(*data)的一级占位符名称的集合。 例1:模板中包含名称占位符<%=*data.name%>,年龄占位符<%=*data.age%>,本参数返回[“name”, “age”]; 例2:模板中包含如下占位符,<%=*data.person.name%>,<%=*data.person.age%>,<%=*data.remark%>,本参数返回[“person”, “remark”]