知识

?php /** * EMS 接口类 */ class Ems { //EMS 接口配置 protected $config = [ server = https://211.156.195.17/ , key = XXXX , //key ] ; // 返回信息 protected $ret = array ( head = ERR , message = 系统错误 , code = - 1 ) ; public

您当前位置>主页 > 知识 > 软件开发 >

邮政快递EMS接口

发表时间:2020-06-12 07:59

文章来源:admin

浏览次数:

<?php

/**
 * EMS接口类
 */
class Ems {

    //EMS接口配置
    protected $config = [
        'server' => "https://211.156.195.17/",
        'key' => 'XXXX', //key
    ];
    //返回信息
    protected $ret = array(
        'head' => "ERR",
        'message' => '系统错误',
        'code' => -1
    );

    public function __construct($params = null) {
        if (null != $params) {
            $this->config = array_merge($this->config, $params);
        }
    }

    /**
     * 发送post请求
     * @param string $url 请求地址
     * @param array $post_data post键值对数据
     * @return string
     */
    function send_post($url, $post_data) {

        $postdata = http_build_query($post_data);
        $options = [
            'http' => [
                'method' => 'POST',
                'header' => 'Content-type:application/x-www-form-urlencoded;charset=utf-8',
                'content' => $postdata,
                'timeout' => 15 * 60 // 超时时间(单位:s            ],
            "ssl" => [
                "verify_peer" => false,
                "verify_peer_name" => false,
            ],
        ];
        $context = stream_context_create($options);
        $result = file_get_contents($url, false, $context);

        return $result;
    }

    public function Order($logistics_order_no, $send_params = array(), $receiver_params = array(), $cargoes = array()) {

        // 下订单
        $sender = $this->paramsToString($send_params, 'sender');
        $receiver = $this->paramsToString($receiver_params, 'receiver');
        $cargoes_str = count($cargoes) > 0 ? $this->paramsToString($cargoes, 'Cargo') : '';

        $xmlContent = "<OrderNormal><created_time>" . date('Y-m-d H:i:s') . "</created_time>
               <logistics_provider>B</logistics_provider>
               <ecommerce_no>Huanbiaokc</ecommerce_no>
               <ecommerce_user_id>2</ecommerce_user_id>
               <sender_type>1</sender_type>
               <sender_no></sender_no>
               <inner_channel>0</inner_channel>
               <logistics_order_no>$logistics_order_no</logistics_order_no>
               <batch_no></batch_no>
               <waybill_no></waybill_no>
               <one_bill_flag>0</one_bill_flag>
               <submail_no>9</submail_no>
               <one_bill_fee_type></one_bill_fee_type>
               <contents_attribute>3</contents_attribute>
               <base_product_no>21210</base_product_no>
               <biz_product_no>112104302300991</biz_product_no>
               <product_type></product_type>
               <weight></weight>
               <volume></volume>
               <length></length>
               <width></width>
               <height></height>
               <postage_total></postage_total>
               <pickup_notes></pickup_notes>
               <insurance_flag>1</insurance_flag>
               <insurance_amount></insurance_amount>
               <deliver_type></deliver_type>
               <deliver_pre_date></deliver_pre_date>
               <pickup_type></pickup_type>
               <pickup_pre_begin_time></pickup_pre_begin_time>
               <pickup_pre_end_time></pickup_pre_end_time>
               <payment_mode></payment_mode>
               <cod_flag></cod_flag>
               <cod_amount></cod_amount>
               <receipt_flag></receipt_flag>
               <receipt_waybill_no></receipt_waybill_no>
               <electronic_preferential_no></electronic_preferential_no>
               <electronic_preferential_amount></electronic_preferential_amount>
               <valuable_flag>0</valuable_flag>
               <sender_safety_code></sender_safety_code>
               <receiver_safety_code></receiver_safety_code>
               <note></note>
               <project_id></project_id>
               $sender
                                        $receiver
               
               <cargos>
                  $cargoes_str
               </cargos>
            </OrderNormal>";
        $data_digest = base64_encode(MD5($xmlContent . $this->config['key'], true));

        $post_data = array(
            'logistics_interface' => $xmlContent,
            'data_digest' => $data_digest,
            'msg_type' => 'ORDERCREATE', // 'ORDERCREATE',
            'ecCompanyId' => 'Huanbiaokc',
        );

        $resultCont = $this->send_post($this->config['server'] . "iwaybillno-web/a/iwaybill/receive", $post_data);
        return $this->parse($resultCont);
    }

    /**
     * XML to 数组.
     * @param string $xml XML string
     * @return array|SimpleXMLElement
     */
    public static function parse($xml)
    {
        $data = simplexml_load_string($xml, 'SimpleXMLElement', LIBXML_NOCDATA | LIBXML_NOBLANKS);
        if (is_object($data) && get_class($data) === 'SimpleXMLElement') {
            $data = self::arrarval($data);
        }
        return $data;
    }

    /**
     * 对象 to 数组.
     * @param string $data
     * @return array
     */
    private static function arrarval($data)
    {
        if (is_object($data) && get_class($data) === 'SimpleXMLElement') {
            $data = (array) $data;
        }
        if (is_array($data)) {
            foreach ($data as $index => $value) {
                $data[$index] = self::arrarval($value);
            }
        }
        return $data;
    }

    /**
     * 转换属性为XML字符串
     * @param array $params
     * @param string $xml_Name
     * @return string
     */
    protected function paramsToString($params = [], $xml_Name = '') {
        $string = '';
        $return_string = '';
        if ($xml_Name && is_array($params)) {
            foreach ($params as $key => $value) {
                if (is_array($value)) {
                    $string = $this->paramsToString($value);
                } else {
                    $string .=  "<$key>$value</$key>";
                }
                $return_string .= "<$xml_Name>$string</$xml_Name>";
            }
        } elseif (!$xml_Name && is_array($params)) {
            foreach ($params as $k => $v) {
                $string .=  "<$k>$v</$k>";
            }
            $return_string = $string;
        }

        return $return_string;
    }

}



 
 
 
 
 
 
 
               中国邮政
“新一代寄递业务信息平台咨询设计”项目
接口需求说明书
 
 
 
1.     前言.................................................................................................................................... 5
1.2        编写目的....................................................................................................................... 5
1.3        预期读者....................................................................................................................... 5
1.4        名词解释....................................................................................................................... 5
2.     订单信息接入................................................................................................................... 1
2.1        接口说明....................................................................................................................... 1
2.2        订单接入接口描述......................................................................................................... 1
2.2.1通用技术描述............................................................................................................... 1
2.2.2安全及数据完整性........................................................................................................ 1
2.2.3【新一代寄递平台:订购服务申请】接口......................................................................... 3
2.2.4【新一代寄递平台:服务审核】接口................................................................................ 5
2.2.5【新一代寄递平台:下单取号】接口................................................................................ 6
2.2.6【新一代寄递平台:订单接入】接口.............................................................................. 12
2.2.7【新一代寄递平台:白名单订阅】接口.......................................................................... 17
2.2.8【新一代寄递平台:订单更新】接口.............................................................................. 20
2.3        附录............................................................................................................................. 22
2.3.1系统错误码................................................................................................................. 22
2.3,2业务错误码................................................................................................................. 22
2.3.3业务产品代码列表....................................................................................................... 22
3.     三级分拣码...................................................................................................................... 23
3.1        CSB接口规范.............................................................................................................. 23
3.1.1         请求报文............................................................................................................... 24
3.1.2         消息头.................................................................................................................. 25
3.1.3         其他入参............................................................................................................... 25
3.1.4         响应报文............................................................................................................... 25
3.2        三级分拣码接口描述.................................................................................................... 26
3.2.1         API服务名称........................................................................................................ 26
3.2.2         接口说明............................................................................................................... 26
3.2.3         接口规则............................................................................................................... 26
3.2.4         数据项说明........................................................................................................... 26
4.     轨迹信息接口................................................................................................................. 29
4.1        实现方式...................................................................................................................... 29
4.2        安全认证...................................................................................................................... 29
4.3        报文格式...................................................................................................................... 30
4.3.1         请求报文............................................................................................................... 30
4.3.2         响应报文............................................................................................................... 31
4.4        业务系统接口描述........................................................................................................ 32
4.4.1         运单轨迹信息获取接口.......................................................................................... 33
4.4.2         运单轨迹信息推送接口.......................................................................................... 34
4.5        附录............................................................................................................................. 35
4.5.1         操作码数据字典.................................................................................................... 35
 
 
  1. 前言
    1. 编写目的
本节是中国邮政(以下简称:中邮,邮政)新一代寄递平台(以下简称本项目,寄递平台项目)架构设计阶段的接口规范说明书。
本节描述新一代寄递平台对某个外围系统的接口需求说明,包括接口协议,报文格式,输入参数,返回参数,数据字典等。
  1. 预期读者
本文档预期对公司涉及系统的不同层面的人员提供对于系统整体的概念和理解:
  • 对于相关人员,包括项目管理,架构师,开发和维护人员,本文档将是了解系统之间接口和功能,开发、测试、运维,并对规划系统的发展,和开发进行管理的重要资料;
 
  1. 名词解释
本文档设计的技术名称缩写如下:
缩写名称 解释
CSB 云服务总线(Cloud Service Bus, 简称CSB)面向专有云和专有域,帮助企业在自己的多个系统之间,或者与合作伙伴以及第三方的系统之间实现跨系统跨协议的服务能力互通
   
 
 
 

  1. 订单信息接入
    1. 接口说明
本节定义了新一代寄递平台与电商平台之间订单接入相互交互的接口规范,用以满足新一代寄递平台与电商平台之间订单信息同步的需求。以便系统集成各方明确各自职责和任务,保障数据在传输中能够保持完整性和准确性,同时能够促进系统集成流程的完善和优化。
包含了相关接口的数据格式、通讯格式和交换方式。
 
  1. 订单接入接口描述

2.2.1通用技术描述

实现方式(协议) HTTPS/XML
测试环境(可选) 示例:(完整HTTPS请求url如下:
https://IP:端口号/interface? logistics_interface=XXX&.....&msg_type=XXX
安全认证 示例:(对消息内容“logistics_interface”字段进行签名验证。签名使用MD5 方式,对消息体的内容进行签名。原理为:通知内容(XML)+系统id,然后进行MD5 ,转换为Base64字符串。)
报文格式 系统之间的数据交互方式均采用XML格式传输,接口开发双方均按照约定的XML进行数据封装和数据解析工作,实现数据传输功能。。
默认格式说明 1.时间格式:yyyy-MM-dd HH24:mm:ss
2.空位是否补齐:否;举例:varchar 类型的不需要补齐,char类型的需要补齐
 

2.2.2安全及数据完整性

2.2.2.1安全以及数据完整性校验

 
1 以HTTP POST方式发送,请求方法的编码格式:“application/x-www-form-urlencoded; charset=UTF-8”;
 
2 用“logistics_interface”字段表示要发送的XML内容;
3 用“data_digest”字段进行签名验证。签名使用MD5方式,对logistics_interface的内容进行签名。原理为:通知内容xml+parternID,然后进行MD5,转换为Base64字符串。
详细解释如下:
◆假设xml内容为: <OrderNormal></OrderNormal>, parternID为123456
◆那么要签名的内容为<OrderNormal></OrderNormal>123456,经过md5和base64后的       内容就为s2A/wV2DiGd5SfX+5hMiAw== ,方法如下:
MessageDigest md5 = MessageDigest.getInstance("MD5");
BASE64Encoder base64en = new BASE64Encoder();
Ret=base64en.encode(md5.digest((str+partnered).getBytes("UTF-8")));
◆然后需要对xml内容(<OrderNormal></OrderNormal>)进行URL编码(字符集为UTF-8), 为:%3Corder%3E%3C%2Forder%3E
◆同样需要对签名的字符串进行URL编码,s2A/wV2DiGd5SfX+5hMiAw==的内容为:       s2A%2FwV2DiGd5SfX%2B5hMiAw%3D%3D
◆最终要发送的数据为:
logistics_interface=%3CRequestOrder%3E%3C%2FRequestOrder%3E&data_digest=s2A%2FwV2DiGd5SfX%2B5hMiAw%3D%3D&msg_type =?
 
4 收到消息后,一定要验证数据是否完整及正确;
5 传输通道安全(https)。
6 繁体字需要上游客户转成简体字,不要繁体字加密,例如地址信息等。
 

2.2.2.2字符串压缩和BASE64编码

字符串压缩是可选项,默认不压缩;如需字符串压缩请向新一代寄递平台明确说明。字符串压缩目前只支持GZIP压缩。
    base64编码是可选项,默认不进行base64编码,如需编码请向新一代寄递平台明确说明。
 

2.2.2.3数据发送和处理流程

电商平台发送数据给新一代平台流程:压缩(可选)-> BASE64编码(可选)-> 数字签名-> 发送;
新一代平台发送数据给电商平台流程:接收-> 数字签名校验-> BASE64解码(可选)-> 解压(可选)->处理;

2.2.2.4接口列表

属性值 说明 默认消息格式 备注
SUBSCRIPTION_APPLY 订购服务申请 XML  
SUBSCRIPTION_AUDIT 服务审核 XML  
ORDERCREATE 创建订单(订单下单取号接口+订单接入接口) XML  
ORDER_WHITE_LIST 白名单订阅接口 XML  
ORDERUPDATE 订单更新 XML  

2.2.3【新一代寄递平台:订购服务申请】接口

 

2.2.3.1公共参数定义

 上游系统发给邮政系统的参数:
        
参数名称 类型 是否必须 描述
msg_type String true 消息类型,默认‘SUBSCRIPTION_APPLY’
msg_id String true 消息ID
from_code String true 调用方编码
data_digest String   true 请求签名
logistics_interface String true 请求报文内容
 

2.2.3.2请求参数定义

名称 类型 字段长度 是否必须 示例值 描述
created_time String 20 TRUE yyyy-mm-dd hh:mm:ss 申请时间
sellerId string 19 TRUE 12345 商家ID
sellerNick string 255 FALSE **官方旗舰店 商家名称
contactPhone string 40 FALSE 13827229088 商家联系方式
customerCode string 40 FALSE 28020380 客户号(直营需要)
subscriptionId string 20 TRUE 1 服务订购申请ID,每次唯一
branchAddress BranchAddress   TRUE   网点地址信息(节点)
branchAddressId long 19 TRUE 1 申请地址ID
provinceName string 50 TRUE 浙江省 省名称
cityName string 50 FALSE 杭州市 市名称(如果是省管区县,则为空)
areaName string 50 FALSE 余杭 区名称
townName string 50 FALSE 余杭街道 街道/镇名称
detailAddress string 256 TRUE 狮山路11号 剩余详细地址信息
postmanId string 20 FALSE 122345 小件员工号
reserved1 string 200 FALSE   预留字段
reserved2 string 200 FALSE   预留字段
reserved3 string 200 FALSE   预留字段
reserved4 string 200 FALSE   预留字段
reserved5 string 200 FALSE   预留字段
 

2.2.3.3响应参数定义

名称 类型 字段长度 是否必须 示例值 描述
success boolean   TRUE TRUE true or false
errorCode string 256 FALSE *** 错误码(见附录)
errorMsg string 512 FALSE ** 错误信息(见附录)

2.2.3.4请求报文示例

<request>
   <created_time>12345</created_time>
    <sellerId>12345</sellerId>
    <sellerNick>XXX官方旗舰店</sellerNick>
    <contactPhone>13827229088</contactPhone>
    <customerCode>28020380</customerCode>
    <subscriptionId>001</subscriptionId>
    <branchAddress>
        <branchAddressId>01</branchAddressId>
        <provinceName>浙江省</provinceName>
        <cityName>杭州市</cityName>
        <areaName>余杭</areaName>
        <townName>余杭街道</townName>
        <detailAddress>狮山路11号</detailAddress>
    </branchAddress>
    <postmanId>122345</postmanId>
<reserved1>122345</reserved1>
<reserved2>122345</reserved2>
<reserved3>122345</reserved3>
<reserved4>122345</reserved4>
<reserved5>122345</reserved5>
</request>
 

2.2.3.5响应报文示例

 
<response>
    <success>true</success>
    <errorCode>***</errorCode>
    <errorMsg>**</errorMsg>
</response>
 
 

2.2.4【新一代寄递平台:服务审核】接口

2.2.4.1公共参数定义

 
 邮政系统发给上游系统的参数:
        
名称 类型 是否必须 描述
msg_type String TRUE 消息类型,默认:‘SUBSCRIPTION_AUDIT’
data_digest String TRUE 请求签名
to_code String FALSE 目的方编码(同配套的订购服务申请接口from_code保持一致 )
logistics_interface String TRUE 请求报文内容
 

2.2.4.2请求参数定义

 
名称 类型 字段长度 是否必须 示例值 描述
sellerId string 19 TRUE 123456789 商家ID
auditor string 20 TRUE 李** 快递公司审核人
subscriptionId string 19 TRUE 123456789 服务订购申请ID(值与订购服务推送接口保持一致)
branchAddressId long 19 TRUE 123456789 申请地址ID,唯一识别这条发货地址记录
pass boolean   TRUE TRUE 是否审批通过true alse
remark string 200 FALSE 0 审核不通过必传(0:商家重复提交;1:商家地址错误)后续待补充
 
reserved1 string 200 FALSE   预留字段
reserved2 string 200 FALSE   预留字段
reserved3 string 200 FALSE   预留字段
reserved4 string 200 FALSE   预留字段
reserved5 string 200 FALSE   预留字段
 

2.2.4.3响应参数定义

名称 类型 字段长度 是否必须 示例值 描述
success boolean   TRUE TRUE true or false
errorCode string 256 FALSE *** 错误码
errorMsg string 512 FALSE ** 错误信息

2.2.4.4请求报文示例

<request>
    <branchCode>210125</branchCode>
    <sellerId>123456789</sellerId>
    <auditor>李**</auditor>
    <subscriptionId>123456789</subscriptionId>
    <branchAddressId>123456789</branchAddressId>
    <pass>true</pass>
    <remark></remark>
<reserved1>122345</reserved1>
<reserved2>122345</reserved2>
<reserved3>122345</reserved3>
<reserved4>122345</reserved4>
<reserved5>122345</reserved5>
</request>
 

2.2.4.5响应报文示例

 
<response>
    <success>false</success>
    <errorCode>***</errorCode>
    <errorMsg>**</errorMsg>
</response>

2.2.5【新一代寄递平台:下单取号】接口

2.2.5.1公共参数定义

 上游系统发给邮政的参数:
        
参数名称 用途
logistics_interface 消息内容
data_digest 消息签名
msg_type 消息类型,如“ORDERCREATE”   
ecCompanyId 电商标识,如“DKH” 
 

2.2.5.2请求报文示例

 
下单请求中消息内容:
    <OrderNormal>
        <created_time>2018-06-13 10:00:00</created_time>
        <logistics_provider>A</logistics_provider>
        <ecommerce_no>Taobao</ecommerce_no>
        <ecommerce_user_id></ecommerce_user_id>
        <sender_type></sender_type>
        <sender_no></sender_no>
        <inner_channel>0</inner_channel>
        <logistics_order_no>LP00086773322982</logistics_order_no>
        <batch_no></batch_no>
        <waybill_no></waybill_no>
        <one_bill_flag>0</one_bill_flag>
        <submail_no>9</submail_no>
        <one_bill_fee_type></one_bill_fee_type>
        <contents_attribute>0</contents_attribute>
        <product_type></product_type>
        <weight></weight>
        <volume></volume>
        <length></length>
        <width></width>
        <height></height>
        <postage_total></postage_total>
        <pickup_notes></pickup_notes>
        <insurance_flag>1</insurance_flag>
        <insurance_amount></insurance_amount>
        <deliver_type></deliver_type>
        <deliver_pre_date></deliver_pre_date>
        <pickup_type></pickup_type>
        <pickup_pre_begin_time></pickup_pre_begin_time>
        <pickup_pre_end_time></pickup_pre_end_time>
        <payment_mode></payment_mode>
        <cod_flag></cod_flag>
        <cod_amount></cod_amount>
        <receipt_flag></receipt_flag>
        <receipt_waybill_no></receipt_waybill_no>
        <electronic_preferential_no></electronic_preferential_no>
        <electronic_preferential_amount></electronic_preferential_amount>
        <valuable_flag>0</valuable_flag>
        <sender_safety_code></sender_safety_code>
        <receiver_safety_code></receiver_safety_code>
        <note></note>
        <project_id></project_id>
        <sender>
            <name>张三</name>
            <post_code>322000</post_code>
            <phone></phone>
            <mobile>18178977225</mobile>
            <prov>江西省</prov>
            <city>南昌市</city>
            <county>昌北区</county>
            <address>稠义路1号金汇化纤8楼左边大门</address>
        </sender>
        <pickup>
            <name>张三</name>
            <post_code>322000</post_code>
            <phone></phone>
            <mobile>18178977225</mobile>
            <prov>江西省</prov>
            <city>南昌市</city>
            <county>昌北区</county>
            <address>稠义路1号金汇化纤8楼左边大门</address>
        </pickup>
        <receiver>
            <name>李四</name>
            <post_code>322000</post_code>
            <phone></phone>
            <mobile>18178977225</mobile>
            <prov>河北省</prov>
            <city>承德市</city>
            <county>丰宁满族自治县</county>
            <address>大阁镇丰宁满族自治县华业街宏森高层鹏伟装饰公司</address>
        </receiver>
        <cargos>
            <Cargo>
                <cargo_name>风衣</cargo_name>
                <cargo_category></cargo_category>
                <cargo_quantity></cargo_quantity>
                <cargo_value></cargo_value>
                <cargo_weight></cargo_weight>
            </Cargo>
            <Cargo>
                <cargo_name>帽子</cargo_name>
                <cargo_category></cargo_category>
                <cargo_quantity></cargo_quantity>
                <cargo_value></cargo_value>
                <cargo_weight></cargo_weight>
            </Cargo>
        </cargos>
    </OrderNormal>
  
 
 

2.2.5.3响应报文示例

 
订单创建结果(非一票多件业务):
XML格式返回成功报文:
<responses>
< responseItems>
< response>
<success>true</success>
<waybill_no>1223345</waybill_no>
</response>
< /responseItems>
</responses>
 
 
XML格式返回失败报文:
<responses>
< responseItems>
< response>
<success>false</success>
< reason>B01< /reason>
</response>
< /responseItems>
</responses>
 
订单创建结果(一票多件业务):
 
XML格式返回成功报文:
<responses>
< responseItems>
< response>
<success>true</success>
<waybill_no>1223345,123456,...</waybill_no>
</response>
< /responseItems>
</responses>
注:<waybill_no>1223345,123456,...</waybill_no>为<waybill_no>主单单号,子单单号,...</waybill_no>,submail_no传值有几个返回几个,中间用英文逗号‘,’隔开,只有一票多件主单邮件号和子单邮件号全部获取到才会返回true并返回所有的邮件号。
 
XML格式返回失败报文:
<responses>
< responseItems>
< response>
<success>false</success>
< reason>B01< /reason>
</response>
< /responseItems>
</responses>
 
注:若一票多件订单没有获取到全部的子单邮件号,则< reason>< /reason>为< reason>B05< /reason>,B05即号段获取失败。
 
 

2.2.5.4数据项说明

请求:
字段名 含义 类型 长度 是否必填 备注  
OrderNormal OrderNormal对象
(节点名称OrderNormal
       
created_time 订单接入时间 String 20 yyyy-mm-dd hh:mm:ss  
logistics _provider 物流承运方 Char 1 A:邮务
B:速递
 
ecommerce_no 渠道来源标识 String 20 大多渠道以拼音首字母为准,例如:仓库配送(CKPS),个别渠道以定义的标准为主,例如:大客户(DKH)。  
ecommerce_user_id 电商客户标识 String 50    
sender_type 客户类型 Int   0 散户 1协议客户默认为1  
sender_no 协议客户代码 String 20    
inner_channel 内部订单来源标识 Int   0:直接对接 1:邮务国内小包订单系统 2:邮务国际小包订单系统 3:速递国内订单系统 4:速递国际订单系统(shipping) 5:在线发货平台------默认为’0’  
logistics_order_no 物流订单号 String 50 物流订单号  
batch_no 批次号 String 50    
waybill_no 运单号 String 20 运单号  
one_bill_flag 一票多件标识 int   一票多件标志:0正常 1一票多件  
submail_no 子单数量(reserved28) String 200 最大‘一主九子’,             即submail_no<=9  
one_bill_fee_type 一票多件计费方式 int   一票多件计费方式:1主单统一计费 2分单免首重计费 3平均重量计费 4主分单单独计费  
contents_attribute 内件性质 int   1:文件  3、物品
2:信函  4、包裹
 
base_product_no 基础产品代码 String 20 见附录  
biz_product_no 业务产品分类(可售卖产品代码) String 20 见附录  
weight 订单重量 Numberic(8,3)   单位:克  
volume 订单体积 Numberic(8,3)   单位:立方厘米  
length Numberic(8,3)   单位:厘米  
width Numberic(8,3)   单位:厘米  
height Numberic(8,3)   单位:厘米  
postage_total 邮费 Numberic(12,2)   单位:元  
pickup_notes 备注 String 1000    
insurance_flag 保险保价标志 int   0:保险保价1:基本2:保价3:保险  
insurance_amount 保价金额 Numberic(12,2)   单位:元  
insurance_premium_amount 保险金额 Numberic(12,2)   单位:元  
deliver_type 投递方式 int   1:客户自提2:上门投递3:智能包裹柜4:网点代投  
deliver_pre_date 投递预约时间 String 20 yyyy-mm-dd hh:mm:ss  
pickup_type 揽收方式 int   揽收方式:0 客户送货上门,1 机构上门揽收  
pickup_pre_begin_time 揽收预约起始时间 String 20 yyyy-mm-dd hh:mm:ss  
pickup_pre_end_time 揽收预约截至时间 String 20 yyyy-mm-dd hh:mm:ss  
payment_mode 付款方式 int   1:寄件人 2:收件人 3:第三方 4:收件人集中付费 5:免费 6:寄/收件人 7:预付卡(到付只有标快产品有此业务)  
cod_flag 代收款标志 int   1:代收货款2:代缴费9:无(代收只有标快产品有此业务)  
cod_amount 代收款金额 Numberic(12,2)   单位:元  
receipt_flag 回单标识 int   1:基本2:回执 3:短信 5:电子返单
6:格式返单7:自备返单8:反向返单 
 
receipt_waybill_no 回单运单号 String 20    
electronic_preferential_no
 
电子优惠券号 String 50    
electronic_preferential_amount 电子优惠券金额 Numberic(12,2)   单位:元  
valuable_flag 贵品标识 int   贵品标识:0 无 1有  
sender_safety_code 寄件人安全码 String      
receiver_safety_code 收件人安全码 String      
note 备注 String   公安交管邮件必填  
project_id 项目标识 String   山西公安户籍(SXGAHJ),公安网上车管(GAWSCG),苹果(APPLE)  
sender 寄件人信息
(节点名称sender)
Address      
pickup 发货人信息
(节点名称pickup)
Address      
receiver 收件人信息
(节点名称receiver)
Address      
cargos 商品信息
(节点名称cargos)
List<Cargo>      
             
Address Address对象          
name 用户姓名 String 200    
post_code 用户邮编 String 20    
phone 用户电话,包括区号、电话号码及分机号,中间用“-”分隔; String 20    
mobile 用户移动电话 String 20    
prov 用户所在省,使用国标全称 String 20    
city 用户所在市,使用国标全称 String 20    
county 用户所在县(区),使用国标全称 String 20    
address 用户详细地址 String 200    
             
cargo Cargo对象
(节点名称Cargo
       
cargo_name 商品名称 String 50  
cargo_category 商品类型 String 50  
cargo_quantity 商品数量 int    
cargo_value 商品单价 Numberic(12,2)   (单位:元)
cargo_weight 商品重量 Numberic(8,3)   (单位:克)
 
 
 

 

2.2.6【新一代寄递平台:订单接入】接口

2.2.6.1公共参数定义

 上游系统发给邮政的参数:
        
参数名称 用途
logistics_interface 消息内容
data_digest 消息签名
msg_type 消息类型,如“ORDERCREATE”   
ecCompanyId 电商标识,如“AMAZON” 
 

2.2.6.2请求报文示例

 
下单请求中消息内容:
<OrderNormals>
    <OrderNormal>
        <created_time>2018-06-13 10:00:00</created_time>
        <logistics_provider>A</logistics_provider>
        <ecommerce_no>Taobao</ecommerce_no>
        <ecommerce_user_id></ecommerce_user_id>
        <sender_type></sender_type>
        <sender_no></sender_no>
        <inner_channel>0</inner_channel>
        <logistics_order_no>LP00086773322982</logistics_order_no>
        <batch_no></batch_no>
        <waybill_no>9891787223649</waybill_no>
        <one_bill_flag>0</one_bill_flag>
        <submail_no></submail_no>
        <one_bill_fee_type></one_bill_fee_type>
        <contents_attribute>0</contents_attribute>
        <product_type></product_type>
        <weight></weight>
        <volume></volume>
        <length></length>
        <width></width>
        <height></height>
        <postage_total></postage_total>
        <pickup_notes></pickup_notes>
        <insurance_flag>1</insurance_flag>
        <insurance_amount></insurance_amount>
        <deliver_type></deliver_type>
        <deliver_pre_date></deliver_pre_date>
        <pickup_type></pickup_type>
        <pickup_pre_begin_time></pickup_pre_begin_time>
        <pickup_pre_end_time></pickup_pre_end_time>
        <payment_mode></payment_mode>
        <cod_flag></cod_flag>
        <cod_amount></cod_amount>
        <receipt_flag></receipt_flag>
        <receipt_waybill_no></receipt_waybill_no>
        <electronic_preferential_no></electronic_preferential_no>
        <electronic_preferential_amount></electronic_preferential_amount>
        <valuable_flag>0</valuable_flag>
        <sender_safety_code></sender_safety_code>
        <receiver_safety_code></receiver_safety_code>
        <note></note>
        <project_id></project_id>
        <sender>
            <name>张三</name>
            <post_code>322000</post_code>
            <phone></phone>
            <mobile>18178977225</mobile>
            <prov>江西省</prov>
            <city>南昌市</city>
            <county>昌北区</county>
            <address>稠义路1号金汇化纤8楼左边大门</address>
        </sender>
        <pickup>
            <name>张三</name>
            <post_code>322000</post_code>
            <phone></phone>
            <mobile>18178977225</mobile>
            <prov>江西省</prov>
            <city>南昌市</city>
            <county>昌北区</county>
            <address>稠义路1号金汇化纤8楼左边大门</address>
        </pickup>
        <receiver>
            <name>李四</name>
            <post_code>322000</post_code>
            <phone></phone>
            <mobile>18178977225</mobile>
            <prov>河北省</prov>
            <city>承德市</city>
            <county>丰宁满族自治县</county>
            <address>大阁镇丰宁满族自治县华业街宏森高层鹏伟装饰公司</address>
        </receiver>
        <cargos>
            <Cargo>
                <cargo_name>风衣</cargo_name>
                <cargo_category></cargo_category>
                <cargo_quantity></cargo_quantity>
                <cargo_value></cargo_value>
                <cargo_weight></cargo_weight>
            </Cargo>
            <Cargo>
                <cargo_name>帽子</cargo_name>
                <cargo_category></cargo_category>
                <cargo_quantity></cargo_quantity>
                <cargo_value></cargo_value>
                <cargo_weight></cargo_weight>
            </Cargo>
        </cargos>
    </OrderNormal>
    <OrderNormal>
...
...
</OrderNormal>
</OrderNormals>
 
 

2.2.6.3响应报文示例

 
订单创建结果:
XML格式成功:
<responses>
<logisticProviderID>XYD</ logisticProviderID> 
< responseItems>
                   < response>
                   <txLogisticID>LP05082300225709000</txLogisticID>
                   <success>true</success>
                   </response>
         < /responseItems>
</responses>
 
XML格式失败:
<responses>
<logisticProviderID>XYD</ logisticProviderID>
< responseItems>
                   <response>
                   <txLogisticID>LP05082300225709000</txLogisticID>
                   <success>false</success>
                   <reason>S01</reason>
                   </response>
         </ responseItems>
</responses>
 
 
 

2.2.6.4数据项说明

请求:
字段名 含义 类型 长度 是否必填 备注  
OrderNormals 根节点,用于批量-最多99条(节点名称OrderNormals List< OrderNormal >        
OrderNormal OrderNormal对象
(节点名称OrderNormal
       
created_time 订单接入时间 String 20 yyyy-mm-dd hh:mm:ss  
logistics _provider 物流承运方 Char 1 A:邮务(快包产品)
B:速递(标快产品)
 
ecommerce_no 渠道来源标识 String 20 大多渠道以拼音首字母为准,例如:仓库配送(CKPS),个别渠道以定义的标准为主,例如:大客户(DKH)。  
ecommerce_user_id 电商客户标识 String 50 客户的店铺ID  
sender_type 客户类型 Int   0 散户 1协议客户默认传1  
sender_no 协议客户代码 String 20    
inner_channel 内部订单来源标识 Int   0:直接对接 1:邮务国内小包订单系统 2:邮务国际小包订单系统 3:速递国内订单系统 4:速递国际订单系统(shipping) 5:在线发货平台默认为0  
logistics_order_no 物流订单号 String 50 物流订单号  
batch_no 批次号 String 50    
waybill_no 运单号 String 20 运单号  
one_bill_flag 一票多件标识 int   一票多件标志:0正常 1一票多件  
submail_no 子单号 String 200 一票多单子单号,以“,”(半角逗号)分隔,非一票多单不填  
one_bill_fee_type 一票多件计费方式 int   一票多件计费方式:1主单统一计费 2分单免首重计费 3平均重量计费 4主分单单独计费  
contents_attribute 内件性质 int   1:文件  3、物品
2:信函  4、包裹
 
product_type 业务产品分类(可售卖产品)业务产品代码 String 20 详见附录业务产品代码列表  
weight 订单重量 Numberic(8,3)   单位:克  
volume 订单体积 Numberic(8,3)   单位:立方厘米  
length Numberic(8,3)   单位:厘米  
width Numberic(8,3)   单位:厘米  
height Numberic(8,3)   单位:厘米  
postage_total 邮费 Numberic(12,2)   单位:元  
pickup_notes 备注 String 1000    
insurance_flag 保险保价标志 int   0:保险保价1:基本2:保价3:保险  
insurance_amount 保价金额 Numberic(12,2)   单位:元  
insurance_premium_amount 保险金额 Numberic(12,2)   单位:元  
deliver_type 投递方式 int   1:客户自提2:上门投递3:智能包裹柜4:网点代投  
deliver_pre_date 投递预约开始时间 Date   yyyy-mm-dd hh:mm:ss(若只有一个日期譬如2020-03-17 14:00:00,则预约开始时间传2020-03-17 00:00:00,预约结束时间传2020-03-17 14:00:00)  
deliver_pre_end_date 投递预约结束时间 Date   yyyy-mm-dd hh:mm:ss  
pickup_type 揽收方式 int   揽收方式:0 客户送货上门,1 机构上门揽收  
pickup_pre_begin_time 揽收预约起始时间 String 20 yyyy-mm-dd hh:mm:ss  
pickup_pre_end_time 揽收预约截至时间 String 20 yyyy-mm-dd hh:mm:ss  
payment_mode 付款方式 int   1:寄件人 2:收件人 3:第三方 4:收件人集中付费 5:免费 6:寄/收件人 7:预付卡  
cod_flag 代收款标志 int   1:代收货款2:代缴费9:无  
cod_amount 代收款金额 Numberic(12,2)   单位:元  
receipt_flag 回单标识 int   1:基本2:回执 3:短信 5:电子返单
6:格式返单7:自备返单8:反向返单 
 
receipt_waybill_no 回单运单号 String 20    
electronic_preferential_no
 
电子优惠券号 String 50    
electronic_preferential_amount 电子优惠券金额 Numberic(12,2)   单位:元  
valuable_flag 贵品标识 int   贵品标识:0 无 1有  
sender_safety_code 寄件人安全码 String      
receiver_safety_code 收件人安全码 String      
note 备注 String   针对公安交管邮件  
project_id 项目标识 String   山西公安户籍(SXGAHJ),公安网上车管(GAWSCG),苹果(APPLE)  
sender 寄件人信息
(节点名称sender)
Address      
pickup 发货人信息
(节点名称pickup)
Address      
receiver 收件人信息
(节点名称receiver)
Address      
cargos 商品信息
(节点名称cargos)
List<Cargo>      
             
Address Address对象          
name 用户姓名 String 200    
post_code 用户邮编 String 20    
phone 用户电话,包括区号、电话号码及分机号,中间用“-”分隔; String 20    
mobile 用户移动电话 String 20    
prov 用户所在省,使用国标全称 String 20    
city 用户所在市,使用国标全称 String 20    
county 用户所在县(区),使用国标全称 String 20    
address 用户详细地址 String 200    
             
cargo Cargo对象
(节点名称Cargo
       
cargo_name 商品名称 String 50  
cargo_category 商品类型 String 50  
cargo_quantity 商品数量 int    
cargo_value 商品单价 Numberic(12,2)   (单位:元)
cargo_weight 商品重量 Numberic(11,3)   (单位:克)
 
 

2.2.7【新一代寄递平台:白名单订阅】接口

2.2.7.1公共参数定义

上游系统发给邮政的参数:
        
参数名称 用途
logistics_interface 消息内容
data_digest 消息签名
msg_type 消息类型,如“ORDER_WHITE_LIST”   
ecCompanyId 电商标识,如“DKH” 

2.2.7.2请求参数定义

 
字段名 含义 类型 长度 是否必填 备注
created_time 订单接入时间 String 20 yyyy-mm-dd hh:mm:ss
ecommerce_no 渠道来源标识 String 20 大多渠道以拼音首字母为准,例如:仓库配送(CKPS),个别渠道以定义的标准为主,例如:大客户(DKH)。
logistics_order_no 物流订单号 String 50 物流订单号(平台唯一)
waybill_no 运单号 String 20 运单号
one_bill_flag 一票多件标志 int   一票多件标志:0正常 1一票多件
submail_no 一票多件子单号 String 200 一票多单子单号,以“,”(半角逗号)分隔,非一票多单不填
reserved1 扩展字段1 String 200 扩展字段1
reserved2 扩展字段2 String 200 扩展字段2
reserved3 扩展字段3 String 200 扩展字段3
reserved4 扩展字段4 String 200 扩展字段4
reserved5 扩展字段5 String 200 扩展字段5
reserved6 扩展字段6 String 200 扩展字段6
reserved7 扩展字段7 String 200 扩展字段7
reserved8 扩展字段8 String 200 扩展字段8
reserved9 扩展字段9 String 200 扩展字段9
reserved10 扩展字段10 String 200 扩展字段10

2.2.7.3响应参数定义

 
字段名 含义 类型 长度 是否必填
logisticProviderID 物流公司编号(默认:JDPT) String 64
txLogisticID 物流订单号 String 64
waybill_no 运单号 String 64
 

2.2.7.4请求报文示例

 
推单请求中消息内容:
<RequestOrders>
<!—白名单基本信息-->
<NormalOrder>
<created_time>2018-12-29 08:00:00</created_time>
<ecommerce_no>TAOBAO</ecommerce_no>
<logistics_order_no>LP05082300225709000</logistics_order_no>
<waybill_no>7082300225709</waybill_no>
<one_bill_flag>0</one_bill_flag>
<submail_no></submail_no>
<reserved1></reserved1>
<reserved2></reserved2>
<reserved3></reserved3>
<reserved4></reserved4>
<reserved5></reserved5>
<reserved6></reserved6>
<reserved7></reserved7>
<reserved8></reserved8>
<reserved9></reserved9>
<reserved10></reserved10>
<NormalOrder>
</RequestOrders>
 

2.2.7.5响应报文示例

推单结果:
XML格式成功:
<responses>
<logisticProviderID>JDPT</ logisticProviderID> 
<txLogisticID>LP05082300225709000</txLogisticID>
<success>true</success>       
</responses>
 
XML格式失败:
<responses>
<logisticProviderID>JDPT</ logisticProviderID>
<txLogisticID>LP05082300225709000</txLogisticID>
<success>false</success>
<reason>S01</reason>
</responses>
 

2.2.8【新一代寄递平台:订单更新】接口

2.2.8.1公共参数定义

 上游系统发给邮政的参数:
参数名称 用途
logistics_interface 消息内容
data_digest 消息签名
msg_type 消息类型,如“ORDERUPDATE”   
ecCompanyId 电商标识,如“AMAZON” 
channel_order_type 国内国际标识,如“GN”“GJ”

2.2.8.2请求报文示例

下单请求中消息内容:
      <RequestOrder>
<logistics_provider>B</logistics_provider>
<ecommerce_no>AMAZON</ecommerce_no>    
        <logistics_order_no>LP00086773322982</logistics_order_no>
        <waybill_no>9891787223649</waybill_no>
        <weight>123</weight>
<volume></volume>
<length></length>
<width></width>
<height></height>
<notes></notes>
<reserved1></reserved1>
<reserved2></reserved2>
<reserved3></reserved3>
<reserved4></reserved4>
<reserved5></reserved5>
<reserved6></reserved6>
      </RequestOrder>

2.2.8.3响应报文示例

XML格式成功:
<response>
<success>true</success>
<waybill_no>1223345</waybill_no>
<logistics_order_no>LP00086773322982</logistics_order_no>
<errorCode></errorCode>
<errorMsg></errorMsg>
</response>
 
XML格式失败:
<response>
<success>false</success>
<waybill_no>1223345</waybill_no>
<logistics_order_no>LP00086773322982</logistics_order_no>
<errorCode>B02</errorCode>
<errorMsg>weight is not numberic,please modify .</errorMsg>
</response>
 

2.2.8.4数据项说明

请求:
字段名 含义 类型 长度 是否必填 备注
logistics_provider 物流承运方 String 1 A:邮务B:速递C:邮速整合(同下单时的传值保持一致)
ecommerce_no 渠道来源标识 String 20 譬如:AMAZON(同eventSource事件源)
logistics_order_no 物流订单号 String 50 物流订单号
waybill_no 运单号 String 20 运单号
weight 订单重量 Numberic(8,3)   单位:克
volume 订单体积 Numberic(8,3)   单位:立方厘米
length Numberic(8,3)   单位:厘米
width Numberic(8,3)   单位:厘米
height Numberic(8,3)   单位:厘米
notes 备注 String 500  
reserved1 扩展字段1 String 200 扩展字段1
reserved2 扩展字段2 String 200 扩展字段2
reserved3 扩展字段3 String 200 扩展字段3
reserved4 扩展字段4 String 200 扩展字段4
reserved5 扩展字段5 String 200 扩展字段5
reserved6 扩展字段6 String 200 扩展字段6
 

2.2.9【新一代寄递平台:订单取消】接口

2.2.9.1公共参数定义

 上游系统发给邮政的参数:
参数名称 用途
logistics_interface 消息内容
data_digest 消息签名
msg_type 消息类型,如“ORDERCANCEL”   
ecCompanyId 电商标识,如“AMAZON” 

2.9.2请求报文示例

下单请求中消息内容:
 
  <logisticsEventsRequest>
  <logisticsEvent>
    <eventHeader>
      <eventType>ORDERCANCEL</eventType>
      <eventTime>2019-02-23 16:37:15</eventTime>
      <eventSource>AMAZON</eventSource>
      <eventTarget>JDPT</eventTarget>
    </eventHeader>
    <eventBody>
      <order>
<logistics_provider>B</logistics_provider>
        <ecommerce_no>AMAZON</ecommerce_no>        
<created_time>2017-12-20 00:00:00</created_time>
        <logistics_order_no>LP00086773322982</logistics_order_no>
        <waybill_no>9891787223649</waybill_no>
        <cancel_reason>123</cancel_reason>
<reserved1></reserved1>
<reserved2></reserved2>
<reserved3></reserved3>
<reserved4></reserved4>
<reserved5></reserved5>
      </order>
    </eventBody>
  </logisticsEvent>
</logisticsEventsRequest>
  
 
 

2.9.3响应报文示例

 
订单取消结果:
订单取消接口报文接收成功---XML格式返回成功报文:
<responses>
< responseItems>
< response>
<logistics_order_no>LP00086773322982</logistics_order_no>
<waybill_no>1223345</waybill_no>
<success>true</success>
<message>订单取消成功</message>
</response>
< /responseItems>
</responses>
 
 
订单取消接口报文接收失败或者订单无法取消---XML格式返回失败报文:
情况一:
<responses>
< responseItems>
< response>
<logistics_order_no>LP00086773322982</logistics_order_no>
<waybill_no>1223345</waybill_no>
<success>false</success>
<message>B01< /message>
</response>
< /responseItems>
</responses>
 
情况二:
<responses>
< responseItems>
< response>
<logistics_order_no>LP00086773322982</logistics_order_no>
<waybill_no>1223345</waybill_no>
<success>false</success>
<message>订单已收寄,无法取消< /message>
</response>
< /responseItems>
</responses>
 

2.9.4数据项说明

2.9.4.1请求:
字段名 含义 类型 长度 是否必填 备注
logisticsEventsRequest logisticsEventsRequest对象(节点名称logisticsEventsRequest      
logisticsEvent logisticsEvent对象(节点名称logisticsEvent      
eventHeader eventHeader对象(节点名称eventHeader      
eventType 事件类型 String 50 默认:ORDERCANCEL
eventTime 事件时间 String 50 默认订单取消时间
eventSource 事件源 String 50 同:ecCompanyId
eventTarget 事件目标 String 50 默认:JDPT
eventBody eventBody对象(节点名称eventBody      
order order对象
(节点名称order
     
logistics_provider 物流承运方 String 1 A:邮务B:速递C:邮速整合(同下单时的传值保持一致)
ecommerce_no 渠道来源标识 String 20 譬如:AMAZON(同eventSource事件源)
created_time 订单接入时间 String 20  
logistics_order_no 物流订单号 String 50 物流订单号
waybill_no 运单号 String 20 运单号
cancel_reason 取消原因 String 200 订单取消原因
reserved1 扩展字段1 String 200 扩展字段1
reserved2 扩展字段2 String 200 扩展字段2
reserved3 扩展字段3 String 200 扩展字段3
reserved4 扩展字段4 String 200 扩展字段4
reserved5 扩展字段5 String 200 扩展字段5
 
 
 
 
  1. 附录

2.3.1系统错误码

标识 说明
S01 非法的XML/JSON 
S02 非法的数字签名
S03 非法的物流公司/仓储公司
S04 非法的通知类型
S05 非法的通知内空
S06 网络超时,请重试
S07 系统异常,请重试
S08 HTTP状态异常(非200)
S09 返回报文为空
S10 找不到对应的网关信息
S11 非法的网关信息
S12 非法的请求参数
S13 业务服务异常

2.3,2业务错误码

 
标识 说明
B00 未知业务错误
B01 关键字段缺失
B02 关键数据格式不正确
B03 没有找到请求的数据
B04 当前数据状态不能进行该项操作
B98 数据保存失败
B05 号段获取失败

2.3.3业务产品代码列表

产品简名 基础产品代码 可售卖产品名称 可售卖产品代码
标准快递 11210 国内EMS促销物品 112104302300991
标准快递 11210 国内EMS促销文件 112104102300991
国内标准快递 11210 国内邮乐快递物品 112104302800991
快递包裹 11312 快递包裹 113124300000691
快递包裹 11312 国内云仓速配物品经济时限代收货款 113124302700611
标准快递 11210 国内EMS促销物品代收货款 112104302300911
标准快递 11210 国内EMS促销物品收件人 112104302300992
标准快递 11210 国内EMS物品收件人 112104300000992
标准快递 11210 国内EMS促销文件收件人 112104102300992
标准快递 11210 国内EMS文件收件人 112104100000992
国际非邮 22210 国际(地区)商业进口航空快件 222105300400991
国际非邮 22210 国际(地区)商业进口陆运快件 222105300400691
国际非邮 22210 进口E特快 222105300451691
国际非邮 22210 国际保税进口航空快件 222105300300991
 
  1. 三级分拣码
本节定义了新一代寄递平台与各电商客户之间相互交互的接口规范,用以满足新一代寄递平台与各电商客户之间数据同步的需求。以便系统集成各方明确各自职责和任务,保障数据在传输和导入处理中能够保持完整性和准确性,同时能够促进系统集成流程的完善和优化。
本文包含了相关接口的接口类型、数据格式、通讯格式和交换方式。本文附录包含了接口使用的基础代码信息。
 
  1. CSB接口规范
接口介绍 云服务总线(CSB),阿里云产品。服务提供者(新一代)发布服务后,调用者可以通过http、webservice等方式调用服务,主要用于实时上行接口。本文档中CSB类型接口默认均使用http协议,阿里的sdk包中已经封装好了客户端的调用,具体sdk下载地址和调用demo,请看下文 csb相关文档及调用demo
实现方式(协议) CSB-HTTP
 
CSB相关文档 阿里云官方文档
https://help.aliyun.com/product/31788.html
调用demo(调用如无特殊需求请使用文档提供的参考方式调用,以尽量避免私有云和公有云之间版本差异造成的调用异常降低联调工作量)
https://github.com/aliyun/csb-sdk/blob/master/http-client/README.md
CSB  SDK下载地址
https://github.com/aliyun/csb-sdk/blob/master/http-client/README.md
 
 
demo
调用方式参考:
 

HttpCaller.doPost方法参数说明
requestURL:对应CSB实例(服务器)地址,由新一代提供
API_NAME:对应的API服务名称,由新一代提供
version:API服务的版本,默认为1.0.0
Params:请求报文,调用对应API服务时输入的参数,类型为map<String,String>
AK,SK:CSB调用者签名密钥,由新一代提供
默认格式说明 1.时间格式:yyyy-MM-dd HH24:mm:ss
2.空位是否补齐:否;举例:varchar 类型的不需要补齐,char类型的需要补齐
3.报文体循环条目数:第一层默认上限999
 
 
  1. 请求报文
       客户端发起请求报文,请求报文为HttpCaller.doPost方法中的params参数(map<String,String>类型,请见上文中的调用demo)
接口列表中具体接口定义中会定义每个接口有几个入参,以及参数参数名,而params的键值对则负责保存这些参数名及参数值
在每个接口中的第一个入参都是消息头,参数名为:messageHeader,参数值为json格式
  1. 消息头
由于是外网没有签名
 
  1. 其他入参
请查看具体接口的请求参数定义
 
  1. 响应报文
服务端对客户端的请求报文提供响应报文,所有报文皆为Json格式的字符串,格式为:{body:{serialNo:’123’,retCode:’000’,retMsg:‘成功’,retDate:’2017-11-09 21:15:22’,retBody:’接口实际返回结果’},RequestId:’4F165030-1380-045E-830C-BDF411779423’,Code:’200’,Message:’成功’}
 
 
字段解释
字段名 含义 类型 长度 是否必填 备注
body Csb平台返回的body Json对象   Csb 返回的body,包含了实际服务返回的内容
serialNo 消息唯一流水号 String 36 消息唯一流水号,为请求时填写的serialNo
 
retCode 返回代码 String 20 000 成功
001 授权错误
002越权查询
010 业务异常
020 系统异常
099 其他
retMsg 返回消息 String 200  
retDate 返回时间 Date   格式为:yyyy-MM-dd HH24:mm:ss
retBody 实际接口返回的内容 String 200 实际接口返回的内容
具体格式内容在各接口规范中定义
Code csb平台返回代码 String 200 200   访问处理成功
500   CSB内部错误
501   所访问的服务API未经授权
502   访问签名未通过验证,也包括所提供的访问凭证不存在的情况
504   所访问的服务API不存在
505   访问凭证缺失
506   访问签名缺失
507   访问参数缺失
508   访问要求通过安全通道进行
509   访问时间戳缺失
510   访问过期,请检查网络通路是否稳定
800   [提供端协议错误码] 提供端协议错误信息
801   服务提供端不可达。如果提供端协议会报告该类型错误,将会通过上面的800 Escape Code体现
Message csb平台返回消息 String 200  
 
 
  1. 三级分拣码接口描述
    1. API服务名称
 routInfoQueryForPDD
  1. 接口说明
外部平台向新一代查询邮路信息(三段码信息)
  1. 接口规则
CSB
  1. 数据项说明

3.2.4.1请求参数

名称 含义 类型 必填 描述
dataDigest 入参1,参数名dataDigest String 请求签名
logisticsInterface 入参2,参数名logisticsInterface List<SingleRouteInfoRequest> 请求报文内容
wpCode 入参3,参数名wpCode String 对接系统标识
如果是快递包裹就传:XXX-YZXB
如果是标快传:XXX-EMS
 
 
SingleRouteInfoRequest说明
名称 类型 是否必须 示例值 描述
senderAddress Address 见下表 发件地址
receiverAddress Address 见下表 收件地址
objectId String 1 发件/收件地址对ID,单次请求中唯一
Address说明
名称 类型 是否必填 示例值 描述
province String 浙江省
city String 杭州市
area String 余杭
town String 余杭街道 街道/镇
detail String 狮山路11号 剩余详细地址
zip String 201100 邮编
 
请求示例
{
"wpCode": "STO",
"dataDigest": "9dd4e461268c8034f5c8564e155c67a6",
"logisticsInterface": [{
"objectId":80302282,
"senderAddress":{
"town":"余杭街道",
"city":"杭州市",
"area":"余杭",
"detail":"狮山路11号",
"province":"浙江省"
"zip":"123456"
},
"receiverAddress":{
"town":"东山街道",
"city":"南京市",
"area":"江宁",
"detail":"东麒路33号A座",
"province":"江苏省"
"zip":"123456"
}
}]
}
 
 
 

3.2.4.2 返回参数

Json/List格式,存在响应报文中的 retBody 中,关于响应报文的格式定义请查看响应报文
 
名称 类型 是否必须 示例值 描述
success Boolean true 请求是否成功
errorCode String   错误码
errorMsg String   错误信息
result List<SingleRouteInfoResponse> 见下表 请求成功时非空
 
 
SingleRouteInfoResponse说明
名称 类型 是否必须 示例值 描述
objectId String 236569 发件/收件地址对ID,单次请求中唯一
success Boolean true 单条查询是否成功
errorCode String   错误码
errorMsg String   错误信息
datoubi String 杭州 大头笔
datoubiCode String 611 大头笔编码
routeCode String 611-200 200 三段码
consolidationList List<Consolidation> 见下表 集包地列表
 
 
Consolidation说明
名称 类型 是否必须 示例值 描述
name String 昆明中转 集包地名称
code String 231 集包地编码
 
响应示例
{
"success": true,
"errorCode": "",
"errorMsg": "",
"result": [
{
"success": true,
"objectId": 20160202,
"datoubi": "重庆市 九龙坡区",
"datoubiCode": null,
"consolidationList": null,
"routeCode": "600-062 001",
"errorCode": null,
"errorMsg": null
},
{
"success": true,
"objectId": 20160203,
"datoubi": "广州市 白云区",
"datoubiCode": null,
"consolidationList": null,
"routeCode": "600-062 000",
"errorCode": null,
"errorMsg": null
}
]
 
 
 
  1. 轨迹信息接口
本节包含了轨迹信息查询接口的数据格式、通讯格式和交换方式。本文附录包含了接口使用的基础代码信息。
 
  1. 实现方式
       系统之间通过发送HTTP POST请求的方式同步获取数据,请求方法的编码格式:“application/x-www-form-urlencoded;charset=UTF-8”。  
       消息头每个属性都作为参数,消息体整体作为一个参数(msgBody)。
 
  1. 安全认证
    消息头添加“dataDigest”字段进行签名验证。签名使用MD5 方式,对消息体的内容进行签名。原理为:通知内容( json )+系统id,然后进行MD5 ,转换为Base64字符串。
 
  1. 报文格式
       系统之间的数据交互方式均采用json格式传输,接口开发双方均按照约定的json消息格式(包括消息头和消息体)进行数据封装和数据解析工作,实现数据传输功能。
消息体采用json格式字符串,(JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。它基于ECMAScript的一个子集。 JSON采用完全独立于语言的文本格式)。
 
  1. 请求报文
客户端发起请求报文
 

4.3.1.1消息头

 
序号 字段 是否必须 名称 说明
1 sendID Y 发送方标识 JDPT:寄递平台
2 proviceNo N 数据生产的省公司代码 对不能确定的省份取99
3 msgKind Y 消息类别 接口编码(JDPT_XXX_TRACE)
4 serialNo Y 消息唯一序列号 相对于消息类别的唯一流水号,对于本类消息,是一个不重复的ID值,不同类别的消息,该值会重复
5 sendDate Y 消息发送日期时间 格式:YYYYMMDDHHMMSS
示例:20171111151501
6 receiveID Y 代表接收方标识 XX:XX系统
7 batchNo N 批次号  
8 dataType Y 数据类型 1-JSON
2-XML
3-压缩后的Byte[]
         
 
【例子】:
sendID               :     JDPT
proviceNo         :     99
msgKind            :     JDPT_XXX_TRACE
serialNo            :     000000000012
sendDate          :     20171111123001
receiveID          :     XXX
batchNo            :     000000000001
dataType           :     1
 

4.3.1.2消息体

【格式详细说明】:标准JSON格式嵌套,编码格式为UTF-8
【例子】:见详细接口描述
消息体使用标准JSON格式嵌套,编码格式为UTF-8,如果数据为数组结构,数组最大长度30(尽量小于30),每个数据项为具体字段组成的对象类型。
实例:
{"msgBody":[{"traceNo":"9891234567890","opTime":"2017-11-11 15:15:00","opOrgCode":"35300001","opCode":"203"}]}
 
  1. 响应报文
服务端对客户端的请求报文提供响应报文。

4.3.2.1消息头

 
序号 字段 是否必须 名称 说明
1 sendID Y 发送方标识 JDPT:寄递平台
2 proviceNo N 数据生产的省公司代码 对不能确定的省份取99
3 msgKind Y 消息类别 接口编码(JDPT_XXX_TRACE)
4 serialNo Y 消息唯一序列号 相对于消息类别的唯一流水号,对于本类消息,是一个不重复的ID值,不同类别的消息,该值会重复
5 sendDate Y 消息发送日期时间 格式:YYYYMMDDHHMISS
示例:20171111151501
6 receiveID Y 代表接收方标识 XX:XX系统
7 batchNo N 批次号  
8 dataType Y 数据类型 1-JSON
2-XML
3-压缩后的Byte[]
         
 
【例子】:
sendID               :     JDPT
proviceNo         :     99
msgKind            :     JDPT_XXX_TRACE
serialNo            :     000000000012
sendDate          :     20171111123001
receiveID          :     XXX
batchNo            :     000000000001
dataType           :     1
 

4.3.2.2消息体

【格式详细说明】:标准JSON格式嵌套,编码格式为UTF-8
【例子】:见详细接口描述
消息体使用标准JSON格式嵌套,编码格式为UTF-8,如果数据为数组结构,数组最大长度30(尽量小于30),每个数据项为具体字段组成的对象类型。
实例:
{"msgBody":[{"traceNo":"9891234567890","opTime":"2017-11-11 15:15:00","opOrgCode":"35300001","opCode":"203"}]}
 
 
 
  1. 业务系统接口描述
 
  1. 运单轨迹信息获取接口

4.4.1.1接口编码

 XXX_JDPT_TRACE

4.4.1.2功能

电商客户向邮政获取运单轨迹信息。

4.4.1.3规则

电商客户系统主动请求。

4.4.1.4数据项说明

请求参数:
序号 字段名(英文) 数据类型 是否必须 描述 备注  
 
【第一层名称(编码)】  
1 traceNo VARCHAR(30) Y 运单号    
【第二层名称(编码)】  
             
             
http://url/interface?sendID=XXX&proviceNo=99&msgKind=XXX_JDPT_TRACE&serialNo=100000000001&sendDate=20171111151500&receiveID=JDPT&batchNo=999&dataType=1&dataDigest=SDFSEROIWSDASDAS&msgBody=URLENCODE({"traceNo":"9891234567890"})  
 
响应参数:
序号 字段名(英文) 数据类型 是否必须 描述 备注  
 
【第一层名称(编码)】  
1 receiveID VARCHAR(20) Y 接收方标识    
2 responseState BOOLEAN Y 调用接口的执行结果 true或false  
3 errorDesc VARCHAR(200) N 错误描述信息    
4 responseItems LIST N 返回的执行结果 List<Response>  
【第二层名称(Response)】  
1 traceNo VARCHAR(30) Y 运单号    
2 opTime DATETIME Y 操作时间 YYYY-MM-DD HH:MM:SS  
3 opCode VARCHAR(10) Y 操作码 详见3.1  
4 opName VARCHAR(50) Y 操作名 详见3.1  
5 opDesc VARCHAR(1000) Y 操作描述    
6 opOrgProvName VARCHAR(300) N 操作网点省名    
7 opOrgCity VARCHAR(300) Y 操作网点城市    
8 opOrgCode VARCHAR(20) Y 操作网点编码    
9 opOrgName VARCHAR(300) Y 操作网点名称    
10 operatorNo VARCHAR(50) N 操作员工号    
11 operatorName VARCHAR(300) N 操作员工名称    
{"receiveID":"JDPT","responseState":true,"errorDesc":"","responseItems":[{"traceNo":"9891234567890","opTime":"2017-11-11 15:15:00","opCode":"203","opName":"收寄","opDesc":"【北京中心】已收寄","opOrgProvName":"北京","opOrgCity":"北京","opOrgCode":"10000001","opOrgName":"北京中心","operatorNo":"10001234","operatorName":"张三"},{"traceNo":"9891234567891","opTime":"2017-11-11 15:15:01","opCode":"203","opName":"收寄","opDesc":"【北京中心】已收寄","opOrgProvName":"北京","opOrgCity":"北京","opOrgCode":"10000001","opOrgName":"北京中心","operatorNo":"10001234","operatorName":"李四"}]}  
 
 
  1. 运单轨迹信息推送接口

4.4.2.1接口编码

 JDPT_XXX_TRACE

4.4.2.2功能

寄递平台向电商客户系统推送的运单轨迹信息。

4.4.2.3规则

根据电商客户业务需求规定触发时间。

4.4.2.4数据项说明

请求参数:
序号 字段名(英文) 数据类型 是否必须 描述 备注  
 
【第一层名称(编码)】  
1 traces LIST N 轨迹列表 List<Trace>  
             
【第二层名称(Trace)】  
1 traceNo VARCHAR(30) Y 运单号    
2 opTime DATETIME Y 操作时间    
3 opCode VARCHAR(10) Y 操作码 详见3.1  
4 opName VARCHAR(50) Y 操作名 详见3.1  
5 opDesc VARCHAR(1000) Y 操作描述    
6 opOrgProvName VARCHAR(300) N 操作网点省名    
7 opOrgCity VARCHAR(300) Y 操作网点城市    
8 opOrgCode VARCHAR(20) Y 操作网点编码    
9 opOrgName VARCHAR(300) Y 操作网点名称    
10 operatorNo VARCHAR(50) N 操作员工号    
11 operatorName VARCHAR(300) N 操作员工名称    
http://url/interface?sendID=JDPT&proviceNo=99&msgKind=JDPT_XXX_TRACE&serialNo=100000000001&sendDate=20171111151500&receiveID=XXX&batchNo=999&dataType=1&dataDigest=SDFSWOIRDDFSASDFSFSD&msgBody=URLENCODE({"traces":[{"traceNo":"9891234567890","opTime":"2017-11-11 15:15:00","opCode":"203","opName":"收寄","opDesc":"【北京中心】已收寄","opOrgProvName":"北京","opOrgCity":"北京","opOrgCode":"10000001","opOrgName":"北京中心","operatorNo":"10001234","operatorName":"张三"},{"traceNo":"9891234567891","opTime":"2017-11-11 15:15:01","opCode":"203","opName":"收寄","opDesc":"【北京中心】已收寄","opOrgProvName":"北京","opOrgCity":"北京","opOrgCode":"10000001","opOrgName":"北京中心","operatorNo":"10001234","operatorName":"李四"}]})  
 
响应参数:
序号 字段名(英文) 数据类型 是否必须 描述 备注  
 
【第一层名称(编码)】  
1 receiveID VARCHAR(20) Y 接收方标识    
2 responseState BOOLEAN Y 调用接口的执行结果 true或false  
3 errorDesc VARCHAR(200) N 错误描述信息    
4 responseItems LIST N 返回的执行结果 List<Response>  
【第二层名称(Response)】  
1 traceNo VARCHAR(30) Y 运单号    
2 success BOOLEAN Y 是否成功 true或false  
3 reason VARCHAR(200) N 失败原因    
{"receiveID":"XXX","responseState":true,"errorDesc":"","responseItems":[{"traceNo":"9891234567890","success":true,"reason":""},{"traceNo":"9891234567891","success":false,"reason":"invalid traceNo"}]}
 
 
 
 
  1. 附录
    1. 操作码数据字典
操作码 操作名 备注
10 收寄  
20 运输  
30 交航 国际
40 启运 国际
50 到达寄达地 国际
60 到达投递局  
70 派件/试投  
80 签收/妥投  
 
  1. 派揽相关接口
5.1上门取件接口(派揽)
5.1.1实现方式
系统之间通过发送HTTPS POST请求的方式同步获取数据,请求方法的编码格式:“application/json;charset=UTF-8”。 
5.1.2安全认证
MD5加密。String sign = HmacUtils.hmacMd5Hex(salt, ogistics_order_no);
测试环境 salt :19dd6c1cec504ac854645f352eb03209
      生产环境 salt :联调完毕提供
 
5.1.3.请求、响应报文
字段名 含义 类型 长度 是否必填 备注  
createdTime 预约时间 String 20 (建议在下单时间1小时以上,并且在营业时间范围内)  
sender_type 客户类型 Int   0 散户 1协议客户  
psegCode 地址码 String 20 (老单要给电子渠道,新单录入 样例123456)  
remarks 备注 String 20 0 财务(美团不需要派揽) 1行政(美团)  
message 留言 String 20    
authorization 授权码 String 20    
pushMethod 推送方式 String 20 (1、散户-及时上门2、协议客户-固定频次上门按照机构配置时间分上下午推送,未维护默认上午9:00和下午16:00两个频次)(美团固定写2)  
sender_no 协议客户代码 String 20    
logistics_order_no 物流订单号 String 50 物流订单号  
batch_no 批次号 String 50    
waybill_no 运单号 String 20 运单号  
one_bill_flag 一票多件标识 int   一票多件标志:0正常 1一票多件  
submail_no 子单数量 String 200 最大‘一主九子’,             即submail_no<=9  
one_bill_fee_type 一票多件计费方式 int   一票多件计费方式:1主单统一计费 2分单免首重计费 3平均重量计费 4主分单单独计费  
contents_attribute 内件性质 int   1:文件  3、物品
2:信函  4、包裹
 
base_product_no 基础产品代码 String 20 见附录  
biz_product_no 业务产品分类(可售卖产品代码) String 20 见附录  
volume 订单体积 Numberic(8,3)   单位:立方厘米  
length Numberic(8,3)   单位:厘米  
width Numberic(8,3)   单位:厘米  
height Numberic(8,3)   单位:厘米  
valuationAmount 声明价值 Numberic(12,2)   单位:元  
shouldPay 应付 = 邮费+保价费 Numberic(12,2)   单位:元  
actuallyPay 实付 Numberic(12,2)   单位:元  
insurance_flag 保险保价标志 int   0:保险保价1:基本2:保价3:保险  
insurance_amount 保价金额 Numberic(12,2)   单位:元  
insurance_premium_amount 保险金额 Numberic(12,2)   单位:元  
deliver_type 投递方式 int   1:客户自提2:上门投递3:智能包裹柜4:网点代投  
deliver_pre_date 投递预约时间 String 20 yyyy-mm-dd hh:mm:ss  
payment_mode 付款方式 int   1:寄件人 2:收件人 3:第三方 4:收件人集中付费 5:免费 6:寄/收件人 7:预付卡  
cod_flag 代收款标志 int   1:代收货款2:投递代缴费 3 收寄代缴费 9:无  
cod_amount 代收款金额 Numberic(12,2)   单位:元  
receipt_flag 回单标识 int   1:基本2:回执 3:短信 5:电子返单
6:格式返单7:自备返单8:反向返单 
 
receipt_waybill_no 回单运单号 String 20    
valuable_flag 贵品标识 int 20 贵品标识:0 无 1有  
sender_safety_code 寄件人安全码 String 20    
receiver_safety_code 收件人安全码 String 20    
orgNo 机构号 String 20    
pickupName 快递员名称 String 20    
pickupNumber 快递员编号 String 20    
pickupPhone 快递员手机号 String 20    
sender 寄件人信息
(节点名称sender)
Address      
             
pickup 发货人信息
(节点名称pickup)
Address      
receiver 收件人信息
(节点名称receiver)
Address      
delivery 上门取件人信息
(节点名称delivery)
delivery      
parcelCabinet 包裹柜信息(节点名称parcelCabinet)  
parcelCabinet
     
cargos 商品信息
(节点名称cargos)
List<Cargo>      
             
Address Address对象          
name 用户姓名 String 200    
post_code 用户邮编 String 20    
phone 用户电话,包括区号、电话号码及分机号,中间用“-”分隔; String 20    
mobile 用户移动电话 String 20    
prov 用户所在省,使用国标全称 String 20    
city 用户所在市,使用国标全称 String 20    
county 用户所在县(区),使用国标全称 String 20    
address 用户详细地址 String 200    
             
delivery delivery对象          
address 上门取件地址 String 200    
prov 上门取件地址所在省 String 20    
city 上门取件地址所在市 String 20    
county 上门取件地址所在区县 String 20    
cardType 证件类型 :1 、身份证 int 20    
card 证件号码 String 20    
cardType1 证件类型 :2 、港澳通行证 int 20    
Card1 证件号码: String 20    
             
volumeWeight 体积重量,单位:克 long      
feeWeight 计费重量,单位:克 long      
ParcelCabinet ParcelCabinet对象          
             
address 快递箱柜地址 String 200    
prov 快递箱柜地址省份 String 20    
city 快递箱柜地址城市 String 20    
county 快递箱柜地址区县 String 20    
code 设备编号 String 20    
pickupCode 快递员开箱码 String 20    
position 箱格信息 大中小 String 20    
name 智能柜 String 20    
cargo Cargo对象
(节点名称Cargo
       
cargo_name 商品名称 String 50  
cargo_category 商品类型 String 50  
cargo_quantity 商品数量 int    
cargo_value 商品单价 Numberic(12,2)   (单位:元)
cargo_weight 商品重量 Numberic(8,3)   (单位:克)
           
           
           
           
           
返回值          
response 返回信息 String    
status   String     F-失败    T-成功
message   String     具体信息(比如成功,异常原因)
               
 
5.1.4报文样例
 
入参:
{
    "sign" :"20c15fe02276c3b876345212d81f4f16",
    "txLogisticID": "EMS181228102129300",
    "orderNo": "181227194419259",
    "mailNo": "1100866792600",
    "orderType": 1,
    "state": "2",
    "valuationAmount": 0,
    "valuationFee": 0,
    "postage": 1,
    "preferential": 100,
    "shouldPay": 1,
    "actuallyPay": 0,
"goodsName": "化妆品",
"createdTime": "2020-04-14 00:00:00",
"pickupTime": "2020-04-14 00:00:00",
"sender_no": "2334410005933",
"orgNo": "23803100",
 
    "sender": {
        "card": "430302199101234544",
        "cardType": "1",
        "name": "傅钰",
        "postCode": "000000",
        "mobile": "13716582152",
        "prov": "北京市",
        "city": "北京市",
        "county": "东城区",
        "address": "三间房东路靠近懋隆文化产业创意园"
    },
    "receiver": {
        "name": "luna",
        "postCode": "000000",
        "mobile": "13711112222",
        "prov": "北京市",
        "city": "北京市",
        "county": "东城区",
        "address": "嘿哈啊1号"
    },
    "collectCabinet": {
        "code": "110105F6112",
        "pickupCode": "GJ1234",
        "position": "小箱格",
        "name": "智能柜",
        "prov": "北京市",
        "city": "北京市",
        "county": "朝阳区",
        "address": "tes33333 testeeeee 北京市朝阳区三间房镇懋麟阁酒店北京懋隆文化产业创意园"
}
"weight":0.1,
"volumeWeight":0.2,
"feeWeight":0.3,
"remarks":"备注",
"message":"留言",
"revertBill":"2",
"revertMailNo":"",
"pushMethod":"1",
}
返回:订单号:181227194419259,EMS 全国下单推送接口,下单成功
 
 
 

5.2派揽状态返回接口(揽投员信息)

接口名称 派揽状态返回接口
 
请求地址  
请求方式 POST
提供方 待定
请求方 中国邮政
接口描述 订单分配快递员接口
请求参数 参数名称 参数类型 是否必填 说明
 
接口参数
txLogisticID String Y 物流订单号
orderCode String N 派揽单编号
downCount String N 下段次数
unitCode  String Y 揽投部机构码
psegCode  String N 地址编码
workerName  String Y 揽收员姓名
workerPhone  String Y 揽收员电话
返回值
返回结果 success String Y 是否接收成功,
T-成功
F-失败
返回信息 errorMsg String N 异常描述
返回数据 errorCode String N 异常代码
 
 
 
5.3揽收结果返回接口
 
接口名称 派揽状态返回接口(成功、拒收)
 
请求地址 待定
请求方式 POST
提供方 中国邮政
请求方 中国邮政
接口描述 订单分配快递员接口
请求参数 参数名称 参数类型 是否必填 说明
 
接口参数
txLogisticID String Y 物流订单号
orderCode String N 派揽单编号
status     揽收结果
揽收成功:1
揽收失败(拒收):0
mailNum String   物流运单号
desc     失败时返回失败原因:空柜、超重、违禁品、超范围、订单信息错误(拒收原因待补充)
postage double   (成功时返回)邮费
  weight double   (成功时返回)重量
返回值
返回结果 success String Y 是否接收成功
T-成功
F-失败
返回信息 errorMsg String N 异常描述
返回数据 errorCode String N 异常代码
5.4上门取件取消接口
 
接口名称 客户主动取消
请求地址 /jdpt-order-pus-web/interface/receive/cancelOrder
请求方式 Post
提供方 中国邮政
请求方 外部系统
接口描述 客户主动取消接口
请求参数 参数名称 参数类型 是否必填 说明
 接口参数 reqId String Y 请求ID,即外部系统的记录号
  cancelCode String Y 异常原因:撤单原因码
13:上门揽收不及时放弃
 19:客户自交寄
 20:客户转交其他公司
 16:已联系客户并确认重复下单
 8:超禁限
 9:超规格
 28:客户取消订单
 12:因资费原因放弃
 22客户更改取件地址
 23EMS到达时限慢
 24测试单
 25客户要求到付
26其他
  ecommerceNo String Y  
  orderNo String Y 订单号
  mailNo String N 物流运单号
  authorization String Y 授权码
返回值
返回结果 orderNo String Y  
返回信息 message String N 异常描述
 
示例
{
  "邮件号": “333325532”,
  "message": "成功",
 
}
5.5揽收范围判断
5.5.1实现方式
系统之间通过发送HTTPS POST请求的方式同步获取数据,请求方法的编码格式:“application/json;charset=UTF-8”。 
5.5.2安全认证
MD5加密。String sign = HmacUtils.hmacMd5Hex(salt,
省市县名称全拼);
测试环境 salt :19dd6c1cec504ac854645f352eb03209
      生产环境 salt :联调完毕提供
 
接口名称 揽收范围判断
请求地址 待定
请求方式 Post
提供方 中国邮政
请求方 外部系统
接口描述 能匹配到机构说明在揽收范围
请求参数 参数名称 参数类型 是否必填 说明
接口参数 address String Y 寄件人地址,必须是带有省市县地址信息,否则影响匹配结
  time String Y 调用时间戳:YYYY-MM-DD HH:MI:SS
  provName String Y 省全称
  cityName String Y 市全称
  contyName String N 区/县全称
         
返回值
返回结果 branchCode String Y 机构代码
  branchName String Y 机构名称
  section String Y 道段代码
  sectionName String Y 道段名称
  Status String Y 状态:0成功 1超范围
 
5.6催单接口
接口名称 客户催单
请求地址 待定
请求方式 Post
提供方 中国邮政
请求方 外部系统
接口描述 客户主动发起催单
请求参数 参数名称 参数类型 是否必填 说明
 接口参数 orderNo String N 订单号
  ecommerceNo String N 下单来源,如快递100/KD100
  authorization String Y 授权码
返回值
返回结果 errorCode String Y 1成功
返回信息 errorMsg String N 异常描述
         
 
失败状态取值
errorCode errorMsg
0 订单号不存在
2 其他错误
3 预约单不能催单
BF 调用接口失败
 



相关项目查看更多