下订单
客户系统向顺丰下发订单, 系统为订单分配运单号。
一、请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| appid | String | 合作伙伴AppId | uwkahf@jfs92 |
| timestamp | String | 当前时间戳 | |
| request_data | String | json格式的业务参数 | 见下表1.1 |
| client_code | String | 顺丰的客户编码 | |
| check_word | String | 顺丰的校验码 | |
| sign | String | 接口签名 | 如何计算生成见示例代码 |
1.1 参数request_data 的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | language | String(10) | 是 | 响应报文的语言, 缺省值为zh-CN,目前支持以下值zh-CN表示中文简体,zh-TW或zh-HK或zh-MO表示中文繁体,en表示英文 | |
| 2 | orderId | String(64) | 是 | 客户订单号 | |
| 3 | waybillNoInfoList | List | 否 | 顺丰运单号 | |
| 4 | customsInfo | CustomsInfo | 否 | 报关信息 ,详细说明见1.4 | |
| 5 | cargoDetails | List | 是 | 托寄物信息 | |
| 6 | cargoDesc | String(20) | 否 | 拖寄物类型描述,如:文件,电子产品,衣服等 ,详细说明见1.3 | |
| 7 | extraInfoList | List | 否 | 扩展属性 详细说明见1.6 | |
| 8 | serviceList | List | 否 | 增值服务信息 ,详细说明见1.3 | |
| 9 | contactInfoList | List | 是 | 收寄双方信息 ,详细说明见1.2 | |
| 10 | monthlyCard | String(20) | 条件 | 顺丰月结卡号月结支付时传值,现结不需传值 | |
| 11 | payMethod | Number(2) | 否 | 1 | 付款方式,支持以下值:1:寄方付 2:收方付 3:第三方付 |
| 12 | expressTypeId | Number(5) | 否 | 1 | 快件产品类别,支持附录快递产品类别表的产品编码值,仅可使用与顺丰销售约定的快件产品 , 查看详细产品列表 |
| 13 | parcelQty | Number(5) | 否 | 1 | 包裹数,一个包裹对应一个运单号;若包裹数大于1,则返回一个母运单号和N-1个子运单号 |
| 14 | totalLength | Number(16,5) | 否 | 客户订单货物总长,单位厘米,精确到小数点后3位,包含子母件 | |
| 15 | totalWidth | Number(16,5) | 否 | 客户订单货物总宽,单位厘米,精确到小数点后3位,包含子母件 | |
| 16 | totalHeight | Number(16,5) | 否 | 客户订单货物总高,单位厘米,精确到小数点后3位,包含子母件 | |
| 17 | totalVolume | Number(16,5) | 否 | 订单货物总体积,单位立方厘米,精确到小数点后3位,会用于计抛(是否计抛具体商务沟通中双方约定) | |
| 18 | totalWeight | Number(17,5) | 条件 | 订单货物总重量,若为子母件必填,单位千克,精确到小数点后3位,如果提供此值,必须>0 (子母件需>6) | |
| 19 | totalNetWeight | Number(17,5) | 否 | 商品总净重 | |
| 20 | sendStartTm | Date | 否 | 接收到报文的时间 | 要求上门取件开始时间,格式:YYYY-MM-DD HH24:MM:SS,示例:2012-7-30 09:30:00 |
| 21 | isDocall | Number(1) | 否 | 0 | 是否通过手持终端通知顺丰收派员上门收件,支持以下值:1:要求 0:不要求 |
| 22 | isSignBack | Number(1) | 否 | 0 | 是否返回签回单(签单返还)的运单号,支持以下值:1:要求 0:不要求 |
| 23 | custReferenceNo | String(100) | 否 | 客户参考编码:如客户原始订单号 | |
| 24 | temperatureRange | Number(2) | 条件 | 温度范围类型,当express_type为12医药温控件时必填,支持以下值:1:冷藏 3:冷冻 | |
| 25 | orderSource | String(50) | 否 | 订单平台类型(对于平台类客户,如果需要在订单中区分订单来源,则可使用此字段) 天猫:tmall,拼多多:pinduoduo,京东 : jd 等平台类型编码 | |
| 27 | remark | String(100) | 否 | 备注 | |
| 28 | isOneselfPickup | Number(1) | 否 | 0 | 快件自取,支持以下值:1:客户同意快件自取0:客户不同意快件自取 |
| 29 | filterField | String | 否 | 筛单特殊字段用来人工筛单 | |
| 30 | isReturnQRCode | Number(1) | 否 | 0 | 是否返回用来退货业务的二维码URL,支持以下值:1:返回二维码 0:不返回二维码 |
| 31 | specialDeliveryTypeCode | String(3) | 否 | 特殊派送类型代码 1:身份验证2:极效前置(当express_type=235时必填) | |
| 32 | specialDeliveryValue | String(100) | 否 | 特殊派件具体表述 specialDeliveryTypeCode为1时,支持以下值1:证件后8位(如1:09296231) specialDeliveryTypeCode为2时,支持以下值且必填Y:超极效前置服务范围则返回普通运单 N:超极效前置服务范围则返回错误码 | |
| 33 | realnameNum | String(100) | 否 | 寄件实名认证流水号 | |
| 34 | merchantPayOrderNo | String(100) | 否 | 商户支付订单号 | |
| 35 | isReturnSignBackRoutelabel | Number(1) | 否 | 0 | 是否返回签回单路由标签:默认0,1:返回路由标签,0:不返回 |
| 36 | isReturnRoutelabel | Number(1) | 否 | 1 | 是否返回路由标签:默认0,1:返回路由标签,0:不返回根据要求,用户默认返回,无需关注此项 |
| 37 | isUnifiedWaybillNo | Number(1) | 否 | 1 | 是否使用国家统一面单号1:是, 0:否(默认)根据要求,用户统一使用标准面单号,无需关注此项 |
| 38 | podModelAddress | String(1024) | 否 | 签单返还范本地址 | |
| 39 | collectEmpCode | String(30) | 否 | 揽收员工号 | |
| 40 | inProcessWaybillNo | String(100) | 否 | 头程运单号 | |
| 41 | isGenWaybillNo | Number(1) | 否 | 是否需求分配运单号1:分配 0:不分配 |
1.2 参数ContactInfo的说明
| # | 属性名 | 类型(约束) | 必填 | 描述 |
|---|---|---|---|---|
| 1 | contactType | Number(1) | 是 | 地址类型:1,寄件方信息 2,到件方信息 |
| 2 | company | String(100) | 条件 | 公司名称 |
| 3 | contact | String(100) | 条件 | 联系人 |
| 4 | tel | String(20) | 条件 | 联系电话 |
| 5 | mobile | String(20) | 否 | 手机 |
| 6 | zoneCode | String(30) | 条件 | 城市代码或国家代码,如果是跨境件,则此字段为必填 |
| 7 | country | String(30) | 是 | 国家或地区 2位代码参照附录国家代码附件 |
| 8 | province | String(30) | 否 | 所在省级行政区名称,必须是标准的省级行政区名称如:北京、广东省、广西壮族自治区等;此字段影响原寄地代码识别,建议尽可能传该字段的值 |
| 9 | city | String(100) | 否 | 所在地级行政区名称,必须是标准的城市称谓 如:北京市、深圳市、大理白族自治州等;此字段影响原寄地代码识别,建议尽可能传该字段的值 |
| 10 | county | String(30) | 否 | 所在县/区级行政区名称,必须是标准的县/区称谓,如:福田区,南涧彝族自治县、准格尔旗等 |
| 11 | address | String(200) | 条件 | 详细地址,若province/city字段的值不传,此字段必须包含省市信息,避免影响原寄地代码识别,如:广东省深圳市福田区新洲十一街万基商务大厦10楼;若需要生成电子运单,则为必填 |
| 12 | postCode | String(25) | 条件 | 邮编,跨境件必填(中国内地,港澳台互寄除外) |
| 13 | String(200) | 否 | 邮箱地址 | |
| 14 | taxNo | String(100) | 否 | 税号 |
| 15 | contactRemark | String(100) | 否 | 联系人属性(跨境件或国际件需要) |
| 16 | cerType | String(200) | 否 | 证件类型(跨境件或国际件需要) |
| 17 | cerNo | String(1000) | 否 | 证件号码(跨境件或国际件需要) |
1.3 参数CargoDetail 的说明
| # | 属性名 | 类型(约束) | 必填 | 描述 |
|---|---|---|---|---|
| 1 | name | String(128) | 是 | 货物名称,如果需要生成电子运单,则为必填 |
| 2 | count | Number(5) | 条件 | 货物数量 跨境件报关需要填写 |
| 3 | unit | String(30) | 条件 | 货物单位,如:个、台、本,跨境件报关需要填写 |
| 4 | weight | Number(16,3) | 条件 | 订单货物单位重量,包含子母件,单位千克,精确到小数点后3位跨境件报关需要填写 |
| 5 | amount | Number(17,3) | 条件 | 货物单价,精确到小数点后3位,跨境件报关需要填写 |
| 6 | currency | String(5) | 条件 | 货物单价的币别:参照附录币别代码附件 |
| 7 | sourceArea | String(5) | 条件 | 原产地国别,跨境件报关需要填写 |
| 8 | productRecordNo | String(18) | 否 | 货物产品国检备案编号 |
| 9 | goodPrepardNo | String(100) | 否 | 商品海关备案号 |
| 10 | taxNo | String(100) | 否 | 商品行邮税号 |
| 11 | hsCode | String(100) | 否 | 海关编码 |
| 12 | goodsCode | String(60) | 否 | 商品编号 |
| 13 | brand | String(60) | 否 | 货物品牌 |
| 14 | specifications | String(60) | 否 | 货物规格型号 |
| 15 | manufacturer | String(100) | 否 | 生产厂家 |
| 16 | shipmentWeight | Double (16,3) | 否 | 托寄物毛重 |
| 17 | length | Double (16,3) | 否 | 托寄物长 |
| 18 | width | Double (16,3) | 否 | 托寄物宽 |
| 19 | height | Double (16,3) | 否 | 托寄物高 |
| 20 | volume | Double (16,2) | 否 | 托寄物体积 |
| 21 | cargoDeclaredValue | Double (16,5) | 否 | 托寄物声明价值 |
| 22 | declaredValueDeclaredCurrency | String(5) | 否 | 托寄物声明价值币别 |
| 23 | cargoId | String(60) | 否 | 货物id(逆向物流) |
| 24 | intelligentInspection | Number(1) | 否 | 智能验货标识(1-是,0-否)(逆向物流) |
| 25 | snCode | String(4000) | 否 | 货物标识码(逆向物流) |
| 26 | stateBarCode | String(50) | 否 | 国条码 |
| 27 | englishName | String(128) | 否 | 货物英文名称 |
| 28 | goodUrl | String(100) | 否 | 商品链接 |
1.3 参数Service的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | name | String(20) | 是 | 增值服务名,如COD等 | |
| 2 | value | String(30) | 条件 | 增值服务扩展属性,参考增值服务传值说明。IN52对应样例:[{“optId”:1}]optId只支持1、2、3且不能为空,对应基础验货、智能验货、组合验货 | |
| 3 | value1 | String(30) | 条件 | 增值服务扩展属性 | |
| 4 | value2 | String(30) | 条件 | 增值服务扩展属性2 | |
| 5 | value3 | String(30) | 条件 | 增值服务扩展属性3 | |
| 6 | value4 | String(30) | 条件 | 增值服务扩展属性4 | |
| 7 | value5 | String(1000) | 条件 | 增值服务扩展属性5 样例:IN67对应:{ “wlCode”: “sku123345667”, “num”: “2”, “price”: “20.0”, “createTime”: “2019-04-15 18:11:39” } IN59对应:{“credentialNo”:”123456”} |
1.4 参数CustomsInfo 的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | declaredValue | Number(16, 5) | 条件 | 客户订单货物总声明价值,包含子母件,精确到小数点后3位。如果是跨境件,则必填 | |
| 2 | declaredValueCurrency | String(5) | 否 | 中国内地默认CNY,否则默认USD | 货物声明价值币别,跨境件报关需要填写参照附录币别代码附件 |
| 3 | customsBatchs | String(20) | 否 | 报关批次 | |
| 4 | taxPayMethod | Number(2) | 否 | 税金付款方式,支持以下值:1:寄付 2:到付 | |
| 5 | taxSettleAccounts | String(30) | 否 | 税金结算账号 | |
| 6 | paymentTool | String(100) | 否 | 支付工具 | |
| 7 | paymentNumber | String(100) | 否 | 支付号码 | |
| 8 | orderName | String(100) | 否 | 客户订单下单人姓名 | |
| 9 | tax | String(10) | 否 | 税款 |
1.5 参数WaybillNoInfo 的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | waybillType | Number(1) | 否 | 运单号类型1:母单 2 :子单 3 : 签回单 | |
| 2 | waybillNo | String(15) | 否 | 运单号 | |
| 3 | boxNo | String(64) | 否 | 箱号 | |
| 4 | length | Number (16,3) | 否 | 长 | |
| 5 | width | Number (16,3) | 否 | 宽 | |
| 6 | height | Number (16,2) | 否 | 高 | |
| 7 | volume | Number (16,2) | 否 | 体积 |
1.6 参数ExtraInfo 的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | attrName | String(256) | 否 | 扩展字段说明:attrName为字段定义,具体如下表,value存在attrVal | |
| 2 | attrVal | String(1024) | 否 | 扩展字段值 |
扩展字段备注
| attrName | attrVal |
|---|---|
| attr001~attr020 | 其中attr005 逆向订单时记录 订单类型 order_type 用来推送lscm “退货订单”与“维修订单” |
| secondSysOrderNo | 二程单号 |
| isCheck | 是否验货 1-验货,其他-不验货 |
| attachment | 委托人的附件图片url地址 |
| agentNo | 代理单号 |
| podModelAddress | 签单返还地址 |
| paymentAmount | 证照支付金额 |
| paymentStatus | 证照支付状态 |
| otherFeeAmt | 其他费用 |
| merchantPayOrderNo | 商户支付订单号 |
| shopCode | 门店编码 |
| inputerEmpCode | 录单员 |
| realnameNum | 寄件实名认证流水号 |
| exportCompName | 进口商公司名称 |
| exportCompTel | 进口商联系电话 |
| exportCompAddr | 进口商地址 |
| wayOfClosing | 成交方式 |
| exportDeclarationMethod | 出口报关方式 |
| importDeclarationMethod | 进口报关方式 |
| personalBaggage | 个人行李 |
| vatNum | VAT号 |
| buyerFreight | 买家运费 |
| buyerNick | 买家昵称 |
| taxPayment | 买家税款 |
| patTime | 支付时间 |
| actPay | 成交金额 |
| buyerPremium | 买家保费 |
| discountAmount | 优惠金额 |
| payName | 支付企业在海关注册登记的企业名称 |
| paycodeCustoms | 支付企业的海关注册登记编号 |
| promotionType | 促销类型 |
| orderName | 订购人 |
| signBackRemark | 签回单备注信息 |
| customerRightsReq | 权益请求信息(详见2.1.2.8) – 2021-1-29-新增 |
| platPayFee | 平台支付金额 (说明:非负数字类型 单位:元)– 爱库存2021-2-3新增 |
| snCodeCheckType | 对snCode进行验货 值为1:验收部分 0:验收所有 – |
1.7 参数CustomerRightsReq 的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | customerRightsReq | List | 是 | 该订单(运单)使用的权益列表 ,详细说明见1.8 |
1.8 参数EquityUseInfo 的说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | rightType | String | 是 | 客户权益编码 | |
| 2 | code | String | 是 | 抵扣产品:增值服务或产品Code | |
| 3 | codeType | String | 是 | 抵扣产品类型:增值服务或产品类型 |
二、请求示例代码
Java
/** * 下单 * @throws Exception */ @Test public void createOrder() throws Exception {
String result =""; String jsonData = "{" + "\"cargoDetails\": [{" + "\"amount\": 308.0," + "\"count\": 1.0," + "\"name\": \"君宝牌地毯\"," + "\"unit\": \"个\"," + "\"volume\": 0.0," + "\"weight\": 0.1" + "}]," + "\"contactInfoList\": [{" + "\"address\": \"十堰市丹江口市公园路155号\"," + "\"city\": \"十堰市\"," + "\"company\": \"清雅轩保健品专营店\"," + "\"contact\": \"张三丰\"," + "\"contactType\": 1," + "\"county\": \"武当山风景区\"," + "\"mobile\": \"17006805888\"," + "\"province\": \"湖北省\"" + "}, {" + "\"address\": \"湖北省襄阳市襄城区环城东路122号\"," + "\"city\": \"襄阳市\"," + "\"contact\": \"郭襄阳\"," + "\"county\": \"襄城区\"," + "\"contactType\": 2," + "\"mobile\": \"18963828829\"," + "\"province\": \"湖北省\"" + "}]," + "\"customsInfo\": {}," + "\"expressTypeId\": 1," + "\"extraInfoList\": []," + "\"isOneselfPickup\": 0," + "\"language\": \"zh-CN\"," +// "\"monthlyCard\": \"75512367xxx\"," + // 月结卡号 "\"orderId\": \"QIAO-20200618-200\"," + "\"parcelQty\": 1," + "\"payMethod\": 1," + "\"totalWeight\": 6" + "}";
CloseableHttpClient httpclient = HttpClients.createDefault(); HttpPost httpPost = new HttpPost( Config.SFExpressCreateOrderUrl );
//业务参数 Map<String, String> data = new HashMap<String, String>(); data.put("appid", Config.AppId); data.put("request_data", jsonData); data.put("client_code", Config.SFClientCode); data.put("check_word", Config.SFCheckWord); Long timestamp = System.currentTimeMillis() / 1000; data.put("timestamp", timestamp.toString());
// 参数签名 data.put("sign", Utils.Sign(data,Config.AppSecret)); List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>(); for (Map.Entry<String, String> entry : data.entrySet()) { params.add(new BasicNameValuePair(entry.getKey(), entry.getValue())); } //发起POST请求 try { httpPost.setEntity(new UrlEncodedFormEntity(params, "UTF-8")); HttpResponse httpResponse = httpclient.execute(httpPost); if (httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_OK) { result = EntityUtils.toString(httpResponse.getEntity()); } else { result = ("doPost Error Response: " + httpResponse.getStatusLine().toString()); } } catch (Exception e) { e.printStackTrace();
}
System.out.println(result);
}三、成功返回结果
{ "code": 0, "message": "ok", "data": { "apiErrorMsg": "", "apiResponseID": "00017A89365B933FEFF713093FC0353F", "apiResultCode": "A1000", "apiResultData": "{\"success\":true,\"errorCode\":\"S0000\",\"errorMsg\":null,\"msgData\":{\"orderId\":\"QIAO-20200618-200\",\"originCode\":\"719\",\"destCode\":\"710BF-001\",\"filterResult\":2,\"remark\":\"4:受雷雨天气影响,您的快件时效预计有所增加,带来不便请您理解!\",\"url\":null,\"paymentLink\":null,\"isUpstairs\":null,\"isSpecialWarehouseService\":null,\"mappingMark\":null,\"agentMailno\":null,\"returnExtraInfoList\":null,\"waybillNoInfoList\":[{\"waybillType\":1,\"waybillNo\":\"SF1303262056675\"}],\"routeLabelInfo\":[{\"code\":\"1000\",\"routeLabelData\":{\"waybillNo\":\"SF1303262056675\",\"sourceTransferCode\":\"719VA\",\"sourceCityCode\":\"719\",\"sourceDeptCode\":\"719J\",\"sourceTeamCode\":\"009\",\"destCityCode\":\"710\",\"destDeptCode\":\"710BF\",\"destDeptCodeMapping\":\"\",\"destTeamCode\":\"001\",\"destTeamCodeMapping\":\"\",\"destTransferCode\":\"710VA\",\"destRouteLabel\":\"710BF-001\",\"proName\":\"顺丰标快\",\"cargoTypeCode\":\"T6\",\"limitTypeCode\":\"T6\",\"expressTypeCode\":\"B1\",\"codingMapping\":\"\",\"codingMappingOut\":\"\",\"xbFlag\":\"0\",\"printFlag\":\"000000000\",\"twoDimensionCode\":\"MMM={'k1':'710VA','k2':'710BF','k3':'001','k4':'T6','k5':'SF1303262056675','k6':'','k7':'46ff3389'}\",\"proCode\":\"T6\",\"printIcon\":\"00000000\",\"abFlag\":\"\",\"destPortCode\":\"\",\"destCountry\":\"\",\"destPostCode\":\"\",\"goodsValueTotal\":\"\",\"currencySymbol\":\"\",\"cusBatch\":\"\",\"goodsNumber\":\"\",\"errMsg\":\"\",\"checkCode\":\"46ff3389\",\"proIcon\":\"\",\"fileIcon\":\"\",\"fbaIcon\":\"\",\"icsmIcon\":\"\",\"destGisDeptCode\":\"710BF\",\"newIcon\":null,\"sendAreaCode\":null,\"destinationStationCode\":null,\"sxLabelDestCode\":null,\"sxDestTransferCode\":null,\"sxCompany\":null,\"newAbFlag\":null,\"destAddrKeyWord\":null,\"rongType\":null},\"message\":\"SF1303262056675:\"}],\"contactInfoList\":null,\"sendStartTm\":null,\"customerRights\":null}}" }, "trace_id": "DNkXs8WxO8CNZbLnTEGJ" }说明: code为0表示成功,非0为失败,message会包含失败原因。
四、失败返回结果
{ "code": 0, "message": "ok", "data": { "apiErrorMsg": "", "apiResponseID": "00017A89DB6EBB3FDAD84ED54CF5EA3F", "apiResultCode": "A1000", "apiResultData": "{\"success\":false,\"errorCode\":\"8016\",\"errorMsg\":\"重复下单\",\"msgData\":null}" }, "trace_id": "gqsC38wDrmwgEEJQapJA"}四、返回参数msgData说明
| # | 属性名 | 类型(约束) | 必填 | 描述 |
|---|---|---|---|---|
| 1 | orderId | String(64) | 是 | 客户订单号 |
| 2 | originCode | String(10) | 否 | 原寄地区域代码,可用于顺丰电子运单标签打印 |
| 3 | destCode | String(10) | 否 | 目的地区域代码,可用于顺丰电子运单标签打印 |
| 4 | filterResult | Number(2) | 否 | 筛单结果:1:人工确认2:可收派3:不可以收派 |
| 5 | remark | String(100) | 条件 | 如果filter_result=3时为必填,不可以收派的原因代码:1:收方超范围2:派方超范围3:其它原因高峰管控提示信息【数字】:【高峰管控提示信息】(如 4:温馨提示 ,1:春运延时) |
| 6 | url | Number(200) | 否 | 二维码URL(用于CX退货操作的URL) |
| 7 | paymentLink | String(200) | 否 | 用于第三方支付运费的URL |
| 8 | isUpstairs | String(1) | 否 | 是否送货上楼 1:是 |
| 9 | isSpecialWarehouseService | String(4) | 否 | true 包含特殊仓库增值服务 |
| 10 | serviceList | List | 否 | 下单补充的增值服务信息 |
| 11 | returnExtraInfoList | List | 否 | 返回信息扩展属性 |
| 12 | waybillNoInfoList | List | 否 | 顺丰运单号 |
| 13 | routeLabelInfo | List | 否 | 路由标签 |
| 14 | customerRights | List | 否 | 权益结果 详见:2.12 |
4.1 参数CustomerRightsResult 说明
| # | 属性名 | 类型(约束 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | channelOrderNo | String | 否 | 渠道端下单的订单id(订单号与运单号至少有一项) | |
| 2 | rightList | List | 是 | 该订单(运单)使用的权益使用结果 见2.13 |
4.2 参数CustomerRightsResult/EquityOrderResultInfo 说明
| # | 属性名 | 类型(约束) | 必填 | 默认值 | 描述 |
|---|---|---|---|---|---|
| 1 | rightType | String | 是 | 客户权益编码 | |
| 2 | code | String | 是 | 抵扣产品:增值服务或产品Code | |
| 3 | codeType | String | 是 | 抵扣产品类型:增值服务或产品类型 | |
| equityFlowId | String | 否 | 当orderSuccess返回true时,这里会返回权益的流水id,也就是权益的唯一id |
4.3 参数OrderResponse /routeLabelInfo 说明
| # | 属性名 | 类型(约束) | 必填 | 描述 |
|---|---|---|---|---|
| 1 | code | String(30) | 是 | 返回调用结果,1000:调用成功;其他调用失败 |
| 2 | routeLabelData | List | 否 | 路由标签数据详细数据 |
| 3 | message | String(1000) | 否 | 失败异常描述 |
4.4 参数OrderResponse/routeLabelInfo/routeLabelData 说明
| # | 属性名 | 类型(约束) | 必填 | 描述 |
|---|---|---|---|---|
| 1 | waybillNo | String(30) | 否 | 运单号 |
| 2 | sourceTransferCode | String(60) | 否 | 原寄地中转场 |
| 3 | sourceCityCode | String(60) | 否 | 原寄地城市代码 |
| 4 | sourceDeptCode | String(60) | 否 | 原寄地网点代码 |
| 5 | sourceTeamCode | String(60 | 否 | 原寄地单元区域 |
| 6 | destCityCode | String(60) | 否 | 目的地城市代码,eg:755 |
| 7 | destDeptCode | String(60) | 否 | 目的地网点代码,eg:755AQ |
| 8 | destDeptCodeMapping | String(60) | 否 | 目的地网点代码映射码 |
| 9 | destTeamCode | String(60) | 否 | 目的地单元区域,eg:001 |
| 10 | destTeamCodeMapping | String(60) | 否 | 目的地单元区域映射码 |
| 11 | destTransferCode | String(60) | 否 | 目的地中转场 |
| 12 | destRouteLabel | String(200) | 否 | 打单时的路由标签信息如果是大网的路由标签,这里的值是目的地网点代码,如果是同城配的路由标签,这里的值是根据同城配的设置映射出来的值,不同的配置结果会不一样,不能根据-符号切分(如:上海同城配,可能是:集散点-目的地网点-接驳点,也有可能是目的地网点代码-集散点-接驳点) |
| 13 | proName | String(60) | 否 | 产品名称对应RLS:pro_name |
| 14 | cargoTypeCode | String(30) | 否 | 快件内容:如:C816、SP601 |
| 15 | limitTypeCode | String(30) | 否 | 时效代码, 如:T4 |
| 16 | expressTypeCode | String(30) | 否 | 产品类型,如:B1 |
| 17 | codingMapping | String(60) | 否 | 入港映射码eg:S10 |
| 18 | codingMappingOut | String(60) | 否 | 出港映射码 |
| 19 | xbFlag | String(30) | 否 | XB标志0:不需要打印XB1:需要打印XB |
| 20 | printFlag | String(60) | 否 | 打印标志返回值总共有9位,每位只有0和1两种,0表示按丰密面单默认的规则,1是显示,顺序如下,如111110000表示打印寄方姓名、寄方电话、寄方公司名、寄方地址和重量,收方姓名、收方电话、收方公司和收方地址按丰密面单默认规则1:寄方姓名2:寄方电话3:寄方公司名4:寄方地址5:重量6:收方姓名7:收方电话8:收方公司名9:收方地址 |
| 21 | twoDimensionCode | String(600) | 否 | 二维码根据规则生成字符串信息,格式为MMM={‘k1’:’(目的地中转场代码)’,’k2’:’(目的地原始网点代码)’,’k3’:’(目的地单元区域)’,’k4’:’(附件通过三维码(express_type_code、 limit_type_code、 cargo_type_code)映射时效类型)’,’k5’:’(运单号)’,’k6’:’(AB标识)’,’k7’:’(校验码)’} |
| 22 | proCode | String(30) | 否 | 时效类型:值为二维码中的K4 |
| 23 | printIcon | String(100) | 否 | 打印图标,根据托寄物判断需要打印的图标(重货,蟹类,生鲜,易碎,Z标)返回值有8位,每一位只有0和1两种,0表示按运单默认的规则,1表示显示。后面两位默认0备用。顺序如下:重货,蟹类,生鲜,易碎,医药类,Z标,0,0如:00000000表示不需要打印重货,蟹类,生鲜,易碎,医药,Z标,备用,备用 |
| 24 | abFlag | String(30) | 否 | AB标 |
| 25 | errMsg | String(1000) | 否 | 查询出现异常时返回信息。返回代码:0 系统异常1 未找到面单 |
| 26 | destPortCode | String(100) | 否 | 目的地口岸代码 |
| 27 | destCountry | String(50) | 否 | 目的国别(国别代码如:JP) |
| 28 | destPostCode | String(100) | 否 | 目的地邮编 |
| 29 | goodsValueTotal | String(30) | 否 | 总价值(保留两位小数,数字类型,可补位) |
| 30 | currencySymbol | String(30) | 否 | 币种 |
| 31 | goodsNumber | String(20) | 否 | 件数 |
| 32 | destGisDeptCode | String(100) | 否 | GIS返回的目的地网点代码 |
| 33 | newIcon | String(100) | 否 | |
| 34 | sendAreaCode | String(100) | 否 | 快运配送编码 |
| 35 | destinationStationCode | String(100) | 否 | 快运目的站编码 |
| 36 | sxLabelDestCode | String(100) | 否 | 快运目的网点 |
| 37 | sxDestTransferCode | String(100) | 否 | 快运目的地中转场 |
| 38 | sxCompany | String(100) | 否 | 快运配送公司:顺丰,顺心 |
4.4 增值服务传值说明举例
更多增值服务可见基础技术-基础资料-增值服务类别表
| 名称 | SERVICECODE | 说明 | 备注 |
|---|---|---|---|
| 代收货款 | COD | value 为货款,value1为协议卡号(可能与月结卡号相同) | |
| 保价 | INSURE | value为声明价值 | |
| 包装服务 | IN67 | ||
| 验货服务 | IN52 | ||
| 定时派送(指定时段) | TDELIVERY | value为派送日期(格式:YYYYMMDD),value1为派送时间段调整为09:00-12:00、12:01-18:00、18:01-21:00三个选项(分别用快捷键1、2、3代表) | value 和 value1必填 |
| 特安 | IN21 | value为声明价值 | |
| 超长超重服务 | IN23 | ||
| 保鲜服务 | IN41 | ||
| 大陆偏远 | IN16 | value为偏远类型 1:寄方偏远 2到方偏远 3 双方偏远 | |
| 委托件 | IN10 | value为委托类型:1、保密;2、带函;3、保密+带函 |