华南通用下单对接文档


1-清单运费推送接口

清单运费推送接口-速运类API

EXP_RECE_WAYBILLS_FEE_PUSH


1. 功能描述
  • 清单费用收费信息推送给客户,推送相关字段信息:订单号、运单号、子单号、月结账号等,根据配置的属性推送。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_WAYBILLS_FEE_PUSH
批量交易 不支持
接口类型 推送
报文类型 application/x-www-form-urlencoded
2.2. 公共请求参数
2.3. 请求参数
元素名 类型(约束) 必填 描述
1 orderNo String(100) Y 客户下单时传入的订单号
2 waybillNo String(100) Y 顺丰下单接口返回的15或12位运单号,母单号 如:SF10116351372291
3 childNos String(100) N 多个用逗号隔开,子母件,当一票有多个包裹时,每个子件的运单号
4 customerAcctCode String(100) N 10位数字,用来做账单结算的账号
5 meterageWeightQty String(100) Y 包裹计费重量 单位kg
6 productName String(100) Y 如顺丰特惠,顺丰标快
7 quantity String(100) Y 托寄物包裹数量
8 volume String(100) N 托寄物总体积
9 feeList List N 费用信息

2.3.1 元素 feeInfo

# 元素名 类型(约束) 必填 描述
1 bizOwnerZoneCode String(100) Y 业务所属地区编码
2 currencyCode String(100) Y 币别
3 customerAcctCode String(100) Y 付款帐号
4 feeAmt String(100) Y 金额
5 feeAmtInd String(100) Y 个性化费用(如一些折扣或加价费用)
6 feeIndType Number(2) Y 个性费用类型
7 gatherEmpCode String(100) Y 交款人
8 gatherZoneCode String(100) Y 收付款网点
9 paymentChangeTypeCode String(100) Y 付款变更类型
10 paymentTypeCode Number(2) Y 付款类型 1 寄付 2 到付 3 第三方付
11 serviceId String(100) Y 运单服务标记,可忽略
12 settlementTypeCode String(100) Y 结算类型 1 现结 2 月结
13 versionNo Number(2) Y 版本号 当红冲后版本号会增加
14 waybillId String(100) Y 运单关联标记 可忽略
15 waybillNo String(50) Y 运单母单号,
16 feeTypeCode String(100) Y 费用类型 1 主运费 2 其他费用 3 保费 4 代收货款服务费 5 代收货款
2.4. 公共响应参数
# 属性名 类型(约束) 必填 默认值 描述
1 success String true 请求成功,false 请求失败
2 errorCode String 错误编码,S0000成功
3 errorMsg String 错误描述
4 msgData String 返回的详细数据
2.5. 响应参数 
# 元素名 类型(约束) 必填 描述
1 code Int Y 200成功 400失败
2 partnerCode String N 合作伙伴code
3 service String N 服务code
4 message String N 失败时返回失败消息
2.6. 请求示例\应用场景(JSON)示例

请求报文:

sign=OGUzOWRhY2Y3N2JkYWNlMTZkOTNkMjI3NzYzNDVkOWU=&content={
    "waybillNo": "444069129271", 
    "customerAcctCode": "9999999999", 
    "childNos": "002803693071,002803693099,002803693080", 
    "orderNo": "1dc300ee-d5bb-465f-86ed-f3f82a326153", 
    "meterageWeightQty": 12.5, 
    "volume": 0, 
    "quantity": 4, 
    "feeList": [
        {
            "bizOwnerZoneCode": "755A", 
            "currencyCode": "CNY", 
            "customerAcctCode": "9999999999", 
            "feeAmt": 1, 
            "feeAmtInd": 1, 
            "feeIndType": 0, 
            "feeTypeCode": "3", 
            "gatherEmpCode": "000212", 
            "gatherZoneCode": "755A", 
            "paymentChangeTypeCode": "0", 
            "paymentTypeCode": "1", 
            "serviceId": -1, 
            "settlementTypeCode": "2", 
            "versionNo": 0, 
            "waybillId": -1, 
            "waybillNo": "444069129271"
        }, 
        {
            "bizOwnerZoneCode": "755A", 
            "currencyCode": "CNY", 
            "customerAcctCode": "9999999999", 
            "feeAmt": 13.2, 
            "feeAmtInd": 13.2, 
            "feeIndType": 0, 
            "feeTypeCode": "1", 
            "gatherEmpCode": "000212", 
            "gatherZoneCode": "755A", 
            "inputTm": 1545203801000, 
            "paymentChangeTypeCode": "0", 
            "paymentTypeCode": "1", 
            "settlementTypeCode": "2", 
            "versionNo": 0, 
            "waybillId": -1, 
            "waybillNo": "444069129271"
        }
    ], 
    "productName": "标准快递"
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "code": 200,
    "partnerCode": "fengqiaoTest",
    "service": "",
    "msgData": ""
}
  • 失败报文-范例1
{
    "code": 400,
    "partnerCode": "fengqiaoTest",
    "service": "",
    "msgData": ""
}
3.1. 错误代码
3.1 (API)平台结果代码列表
标识 说明 解决方法
A1000 统一接入平台校验成功,调用后端服务成功;注意:不代表后端业务处理成功,实际业务处理结果,需要查看响应属性apiResultData中的详细结果 表示接口调用正常
A1001 必传参数不可为空 请做以下几点检查:1、参数列表必传字段未填写2、请求报文头,未配置Content-type:application/x-www-form-urlencoded 3、参数key存在空格问题4、http请求参数都通过http URL编码传送5、业务数据报文(msgData)为json报文数据格式6、接口整体报文为form表单
A1002 请求时效已过期 使用OAuth2认证会产生该提示请检查业务接口的已作废参数是否超过2小时,2小时口令会更新,请调用OAuth2认证接口重新获取
A1003 IP无效 顾客编码(已作废)配置了需校验IP,请解除校验或按绑定IP调用接口
A1004 无对应服务权限 可能存在的原因:1、顾客编码(已作废)没有配置(关联)对应接口的业务接口,请在【开发者对接】-【API列表】中关联;2、接口请求数据与实际环境不一致,请先查看【开发者对接】-【API列表】接口状态:a、【测试中】请使用沙箱环境b、【已上线】请使用正式环境;3、后台配置没有生效,可等待2分钟后在试试,如果还是无法操作,请报障人工处理
A1005 流量受控 丰桥为接口功能联调环境,接口整体都有限流管控,单客户编码对应的每个接口限流规则:1、单接口调用30次/s 2、单接口调用3000次/天请尽量只操作功能联调,切勿进行接口压测,谢谢!
A1006 数字签名无效 请做以下几点检查:1、确认checkword是否配置正确2、确认verifyCode、已作废是否加密加签正确3、确认参数是否有特殊字符,如:&4、参数整体式form表单格式5、非java类语言,需注意特殊字符,目前支持的特殊字符“*”,“空格”,“-”请优先使用6、如果数字签名操作不便,可改为OAuth2认证,Token交互即可,具体参见【开发规范】【鉴权方式说明】
A1007 重复请求 接口层暂未启用,业务层主要是针对下单接口,客户请求参数msgData中的orderId请不要重复使用,修改后在调用接口
A1008 数据解密失败 在特殊场景中使用,如有出现请报障人工处理
A1009 目标服务异常或不可达 接口下游服务异常,如有出现请报障人工处理
A1010 状态为沙箱测试 该问题在老客户中会有此类问题,新客户不会出现,如有出现请报障人工处理
A1099 系统异常 接口服务异常,如有出现请报障人工处理
3.2 业务异常代码
原因代码 errorCode 描述 errorMsg 分类
S0000 成功
S0001 非法的JSON格式 系统错误
S0002 必填参数为空 系统错误
S0003 系统发生数据错误或运行时异常 系统错误
3.2.1 业务状态编码
状态码 状态描述
04 调度失败/等待
04-40001 调度成功+收派员信息
04-40037 下单已接收
04-40002-40021 电话号码异常(电话错误/空号/停机)
04-40002-40022 无法进入客户处,且客户不愿出来
04-40002-40004 暂未联系上客户(电话无人接听/无法接通/关机)
04-40002-40005 经客户同意,更改收派时间
04-40002-40027 天气原因,延误收派件
04-40002-40028 交通原因,延误收派件
04-40002-40031 不符合收件要求,无法揽收
04-40002-40014 客户取消寄件
04-40002-40015 客户重复下单
04-40002-40016 下错单需转单
04-40002-40035 工作量过大,延误收派件
04-40002-40036 重货需转单
00-40045-1000 调度取消订单
00-2000 客户已取消订单
05-40003 已正常收件状态

页面列表

ITEM_HTML