# 增加运费模版
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:addfreighttemplate
可通过该接口增加运费模板
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/merchant/addfreighttemplate?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.merchant.addfreighttemplate
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:130
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
freight_template | object | 是 | 运费模板详细信息 |
# Body.freight_template Object Payload
运费模板详细信息
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
template_id | number | 是 | 模板id |
name | string | 是 | 模板名称 |
valuation_type | number | 是 | 计费类型 PIECE:按件数 WEIGHT:按重量 |
send_time | number | 是 | 发货时间期限,具体枚举值请参考下文 |
address_info | object | 是 | 发货地址 |
delivery_type | number | 是 | 运输方式 EXPRESS:快递 |
shipping_method | number | 是 | 计费方式 FREE:包邮 CONDITION_FREE:条件包邮 NO_FREE:不包邮 |
all_condition_free_detail | object | 是 | 条件包邮详情 |
all_freight_calc_method | object | 是 | 具体计费方法,默认运费,指定地区运费等 |
create_time | number | 是 | 创建时间戳 |
update_time | number | 是 | 更新时间戳 |
is_default | boolean | 是 | 是否默认模板 |
not_send_area | object | 是 | 不发货区域 |
# Body.freight_template.address_info Object Payload
发货地址
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
user_name | string | 否 | 收货人姓名 |
postal_code | string | 否 | 邮编 |
province_name | string | 是 | 国标收货地址第一级地址,可调用获取地址编码获取 |
city_name | string | 否 | 国标收货地址第二级地址,如果是直辖市,请填区,比如"浦东新区",可调用获取地址编码获取 |
county_name | string | 否 | 国标收货地址第三级地址,可调用获取地址编码获取 |
detail_info | string | 否 | 详细收货地址信息 |
national_code | string | 否 | 收货地址国家码 |
tel_number | string | 否 | 收货人手机号码 |
lat | number | 否 | 纬度 |
lng | number | 否 | 经度 |
house_number | string | 否 | 门牌号 |
# Body.freight_template.all_condition_free_detail Object Payload
条件包邮详情
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
condition_free_detail_list | objarray | 否 | 计费规则列表 |
# Body.freight_template.all_condition_free_detail.condition_free_detail_list(Array) Object Payload
计费规则列表
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
address_infos | objarray | 是 | 支持的地址列表 |
min_piece | number | 是 | 最低件数 |
min_weight | number | 是 | 最低重量,单位千克,订单商品总质量小于一千克,算作一千克 |
min_amount | number | 是 | 最低金额,单位(分) |
valuation_flag | number | 是 | 计费方式对应的选项是否已设置 |
amount_flag | number | 是 | 金额是否设置 |
# Body.freight_template.all_condition_free_detail.condition_free_detail_list(Array).address_infosObject Payload
Object Payload
支持的地址列表
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
user_name | string | 否 | 收货人姓名 |
postal_code | string | 否 | 邮编 |
province_name | string | 否 | 国标收货地址第一级地址,可调用获取地址编码获取 |
city_name | string | 否 | 国标收货地址第二级地址,如果是直辖市,请填区,比如"浦东新区",可调用获取地址编码获取 |
county_name | string | 否 | 国标收货地址第三级地址,可调用获取地址编码获取 |
detail_info | string | 否 | 详细收货地址信息 |
national_code | string | 否 | 收货地址国家码 |
tel_number | string | 否 | 收货人手机号码 |
lat | number | 否 | 纬度 |
lng | number | 否 | 经度 |
house_number | string | 否 | 门牌号 |
# Body.freight_template.all_freight_calc_method Object Payload
具体计费方法,默认运费,指定地区运费等
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
freight_calc_method_list | objarray | 否 | freight_calc_method_list |
# Body.freight_template.all_freight_calc_method.freight_calc_method_list(Array) Object Payload
freight_calc_method_list
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
address_infos | objarray | 否 | 支持的地址列表 |
is_default | boolean | 否 | 是否默认运费 |
delivery_id | string | 否 | 快递公司 |
first_val_amount | number | 否 | 首段运费需要满足的数量 |
first_price | number | 否 | 首段运费的金额 |
second_val_amount | number | 否 | 续费的数量 |
second_price | number | 否 | 续费的金额 |
# Body.freight_template.all_freight_calc_method.freight_calc_method_list(Array).address_infosObject Payload
Object Payload
支持的地址列表
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
user_name | string | 否 | 收货人姓名 |
postal_code | string | 否 | 邮编 |
province_name | string | 否 | 国标收货地址第一级地址,可调用获取地址编码获取 |
city_name | string | 否 | 国标收货地址第二级地址,如果是直辖市,请填区,比如"浦东新区",可调用获取地址编码获取 |
county_name | string | 否 | 国标收货地址第三级地址,可调用获取地址编码获取 |
detail_info | string | 否 | 详细收货地址信息 |
national_code | string | 否 | 收货地址国家码 |
tel_number | string | 否 | 收货人手机号码 |
lat | number | 否 | 纬度 |
lng | number | 否 | 经度 |
house_number | string | 否 | 门牌号 |
# Body.freight_template.not_send_area Object Payload
不发货区域
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
address_infos | objarray | 是 | 不支持的地址列表 |
# Body.freight_template.not_send_area.address_infos(Array) Object Payload
不支持的地址列表
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
user_name | string | 否 | 收货人姓名 |
postal_code | string | 否 | 邮编 |
province_name | string | 否 | 国标收货地址第一级地址,可调用获取地址编码获取 |
city_name | string | 否 | 国标收货地址第二级地址,如果是直辖市,请填区,比如"浦东新区",可调用获取地址编码获取 |
county_name | string | 否 | 国标收货地址第三级地址,可调用获取地址编码获取 |
detail_info | string | 否 | 详细收货地址信息 |
national_code | string | 否 | 收货地址国家码 |
tel_number | string | 否 | 收货人手机号码 |
lat | number | 否 | 纬度 |
lng | number | 否 | 经度 |
house_number | string | 否 | 门牌号 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
template_id | string | 123123 | 运费模板id |
# 4. 注意事项
send_time发货时间期限
枚举值 | 描述 (已不支持「3天内发货」,详情) |
---|---|
SendTime_TWENTYFOUR_HOUR | 24小时内发货 |
SendTime_FOUTYEIGHT_HOUR | 48小时内发货 |
# 5. 代码示例
请求示例
{
"freight_template": {
"name": "测试api",
"valuation_type": "PIECE",
"send_time": "SendTime_FOUR_HOUR",
"address_info": {
"user_name": "",
"postal_code": "12345",
"province_name": "广东省",
"city_name": "广州市",
"county_name": "海珠区",
"detail_info": "新港中路",
"national_code": "23456",
"tel_number": "12345"
},
"delivery_type": "EXPRESS",
"shipping_method": "FREE",
"is_default": false
}
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"template_id": "123123"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10021053 | 非法的默认运费模板规则,默认运费不可以指定地址 | |
10021054 | 非法的省市区信息 | |
10021055 | 运费模板必须包含默认规则 | |
10021081 | 运费模板未设置发货地址 | |
10021082 | 非法的发货时间 | |
10021200 | 请检查模板名是否已存在 | |
10025501 | 禁止设置全国不发货 | |
10025502 | 快递公司数量超过上限 | |
10025503 | 条件包邮规则超过上限 | |
10025504 | 计费规则超过上限 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。