3.查询订单接口
<h3>功能描述</h3>
<ul>
<li>该接口用于：
1.客户系统向顺丰快递管家请求国际件订单信息；</li>
</ul>
<h3>接口定义</h3>
<table>
<thead>
<tr>
<th style="text-align: center;">服务名称</th>
<th style="text-align: center;">批量交易</th>
<th style="text-align: center;">接口类型</th>
<th style="text-align: center;">接口uri</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">下订单</td>
<td style="text-align: center;">不支持</td>
<td style="text-align: center;">接入/POST</td>
<td style="text-align: center;">/public/internationalOrder/v1/query</td>
</tr>
</tbody>
</table>
<h3><strong>元素<请求Body></strong></h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>必填</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>companyId</td>
<td>String(50)</td>
<td>Y</td>
<td>分配客户sendAppId</td>
</tr>
<tr>
<td>2</td>
<td>version</td>
<td>String</td>
<td>否</td>
<td>版本号（默认为空即可）</td>
</tr>
<tr>
<td>3</td>
<td>sfWaybillNo</td>
<td>String</td>
<td>否</td>
<td>顺丰运单号(母单号)，客户订单号customerOrderNo、 顺丰运单号sfWayBillNo至少填一个，如果两个都填写，校验是否为同一订单</td>
</tr>
<tr>
<td>4</td>
<td>customerOrderNo</td>
<td>String</td>
<td>否</td>
<td>客户订单号，客户订单号customerOrderNo、 顺丰运单号sfWayBillNo至少填一个，如果两个都填写，校验是否为同一订单</td>
</tr>
</tbody>
</table>
<h3>元素<响应></h3>
<table>
<thead>
<tr>
<th style="text-align: center;">序号</th>
<th style="text-align: center;">字段名</th>
<th style="text-align: center;">类型（约束）</th>
<th style="text-align: center;">必填</th>
<th style="text-align: center;">字段说明</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">1</td>
<td style="text-align: center;">msg</td>
<td style="text-align: center;">String (200)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">信息</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: center;">2</td>
<td style="text-align: center;">succ</td>
<td style="text-align: center;">String (10)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">状态码</td>
<td style="text-align: left;">返回成功或失败信息(ok/fail)</td>
</tr>
<tr>
<td style="text-align: center;">3</td>
<td style="text-align: center;">result</td>
<td style="text-align: center;">String (/)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">数据</td>
<td style="text-align: left;">数据</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>result**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>customerOrderNo</td>
<td>String(64)</td>
<td>客户订单号</td>
</tr>
<tr>
<td>2</td>
<td>customerOrderNoTwo</td>
<td>String(64)</td>
<td>客户订单号2</td>
</tr>
<tr>
<td>3</td>
<td>sfWaybillNo</td>
<td>String(32)</td>
<td>顺丰运单号</td>
</tr>
<tr>
<td>4</td>
<td>interProductCode</td>
<td>String(32)</td>
<td>国际产品映射码</td>
</tr>
<tr>
<td>5</td>
<td>parcelQuantity</td>
<td>Int(8)</td>
<td>包裹总件数(大于1表示是子母件，最大值300)</td>
</tr>
<tr>
<td>6</td>
<td>parcelTotalWeight</td>
<td>BigDecimal(16,2)</td>
<td>包裹总重量。精确到小数点后2位</td>
</tr>
<tr>
<td>7</td>
<td>parcelWeightUnit</td>
<td>String(16)</td>
<td>包裹总重量单位</td>
</tr>
<tr>
<td>8</td>
<td>parcelTotalLength</td>
<td>BigDecimal(16,2)</td>
<td>客户订单货物总长。精确到小数点后2位</td>
</tr>
<tr>
<td>9</td>
<td>parcelTotalWidth</td>
<td>BigDecimal(16,2)</td>
<td>客户订单货物总宽。精确到小数点后2位</td>
</tr>
<tr>
<td>10</td>
<td>parcelTotalHeight</td>
<td>BigDecimal(16,2)</td>
<td>客户订单货物总高。精确到小数点后2位</td>
</tr>
<tr>
<td>11</td>
<td>declaredValue</td>
<td>String(20)</td>
<td>申明价值</td>
</tr>
<tr>
<td>12</td>
<td>declaredCurrency</td>
<td>String(10)</td>
<td>包裹总计声明价值币种</td>
</tr>
<tr>
<td>13</td>
<td>parcelVolumeUnit</td>
<td>String(16)</td>
<td>客户订单货物长度单位1.可选项：CM、INCH2.默认单位为CM3.原寄国为CA和US，长度单位为英寸</td>
</tr>
<tr>
<td>14</td>
<td>pickupType</td>
<td>String(2)</td>
<td>寄件方式 0-服务点自寄或自行联系快递员； 1-上门收件；</td>
</tr>
<tr>
<td>15</td>
<td>pickupAppointTime</td>
<td>String(20)</td>
<td>上门取件预约时间。格式：yyyy-MM-dd HH:mm若寄件方式选择了上门收件，则预约方式必填</td>
</tr>
<tr>
<td>16</td>
<td>pickupAppointTimeZone</td>
<td>String(100)</td>
<td>上门预约时间时区详细参考附录字典</td>
</tr>
<tr>
<td>17</td>
<td>remark</td>
<td>String(200)</td>
<td>运单备注</td>
</tr>
<tr>
<td>18</td>
<td>orderExtendInfo</td>
<td>OrderExtendInfo</td>
<td>订单额外信息</td>
</tr>
<tr>
<td>19</td>
<td>paymentInfo</td>
<td>PaymentInfo</td>
<td>付款方式信息</td>
</tr>
<tr>
<td>20</td>
<td>senderInfo</td>
<td>SenderInfo</td>
<td>寄件人信息</td>
</tr>
<tr>
<td>21</td>
<td>receiverInfo</td>
<td>ReceiverInfo</td>
<td>收件人信息</td>
</tr>
<tr>
<td>22</td>
<td>customsInfo</td>
<td>CustomsInfo</td>
<td>报关信息</td>
</tr>
<tr>
<td>23</td>
<td>parcelInfoList</td>
<td>ParcelInfo</td>
<td>包裹信息</td>
</tr>
<tr>
<td>24</td>
<td>addServiceInfoList</td>
<td>AddServiceInfo</td>
<td>增值服务信息</td>
</tr>
<tr>
<td>25</td>
<td>childInfoList</td>
<td>ChildInfo</td>
<td>子单信息</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>OrderExtendInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>isSignBack</td>
<td>String(8)</td>
<td>是否要求签回单;0.否1.是（签回原寄地）2.是（签回第三方地址）</td>
</tr>
<tr>
<td>2</td>
<td>isSelfPick</td>
<td>String(8)</td>
<td>是否自取件：0-否；1-是</td>
</tr>
<tr>
<td>3</td>
<td>signBackWaybillNo</td>
<td>String(32)</td>
<td>签回回单号</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>PaymentInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>payMethod</td>
<td>String(8)</td>
<td>付款方式：1-寄方付; 2-收方付; 3-第三方付</td>
</tr>
<tr>
<td>2</td>
<td>payMonthCard</td>
<td>String(20)</td>
<td>月结卡号</td>
</tr>
<tr>
<td>3</td>
<td>taxPayMethod</td>
<td>String(8)</td>
<td>税金付款方式：1-寄方付; 2-收方付; 3-第三方付</td>
</tr>
<tr>
<td>4</td>
<td>taxPayMonthCard</td>
<td>String(20)</td>
<td>税金结算账号</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>SenderInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>company</td>
<td>String(100)</td>
<td>寄件方公司</td>
</tr>
<tr>
<td>2</td>
<td>contact</td>
<td>String(100)</td>
<td>寄件方姓名</td>
</tr>
<tr>
<td>3</td>
<td>country</td>
<td>String(5)</td>
<td>寄件方国家/地区，如：CN,US,JP,KR,SG,MY更多参考附录字典</td>
</tr>
<tr>
<td>4</td>
<td>postCode</td>
<td>String(20)</td>
<td>邮编</td>
</tr>
<tr>
<td>5</td>
<td>regionFirst</td>
<td>String(128)</td>
<td>寄件方地址一级区划（州/省）</td>
</tr>
<tr>
<td>6</td>
<td>regionSecond</td>
<td>String(128)</td>
<td>寄件方地址二级区划（城市）</td>
</tr>
<tr>
<td>7</td>
<td>regionThird</td>
<td>String(128)</td>
<td>寄件方地址三级区划（区/县）</td>
</tr>
<tr>
<td>8</td>
<td>address</td>
<td>String(200)</td>
<td>寄件方详细地址</td>
</tr>
<tr>
<td>9</td>
<td>email</td>
<td>String(128)</td>
<td>寄件方邮箱</td>
</tr>
<tr>
<td>10</td>
<td>telAreaCode</td>
<td>String(10)</td>
<td>寄件方固定电话区号</td>
</tr>
<tr>
<td>11</td>
<td>telNo</td>
<td>String(20)</td>
<td>寄件方固定电话。寄件方手机号和寄件方固定电话至少填写一个</td>
</tr>
<tr>
<td>12</td>
<td>phoneAreaCode</td>
<td>String(10)</td>
<td>寄件方移动电话区号</td>
</tr>
<tr>
<td>13</td>
<td>phoneNo</td>
<td>String(20)</td>
<td>寄件方移动电话。寄件方手机号和寄件方固定电话至少填写一个</td>
</tr>
<tr>
<td>14</td>
<td>cargoType</td>
<td>INT(1)</td>
<td>寄件方货物类型：1-个人件；2-公司件</td>
</tr>
<tr>
<td>15</td>
<td>certType</td>
<td>String(10)</td>
<td>寄件方证件类型详细参考附录字典</td>
</tr>
<tr>
<td>16</td>
<td>certCardNo</td>
<td>String(100)</td>
<td>寄件方证件号</td>
</tr>
<tr>
<td>17</td>
<td>vat</td>
<td>String(18)</td>
<td>寄件方VAT号</td>
</tr>
<tr>
<td>18</td>
<td>eori</td>
<td>String(100)</td>
<td>寄件方EORI号</td>
</tr>
<tr>
<td>19</td>
<td>iossNo</td>
<td>String(100)</td>
<td>寄件方IOSS号</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>ReceiverInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>company</td>
<td>String(100)</td>
<td>收件方公司</td>
</tr>
<tr>
<td>2</td>
<td>contact</td>
<td>String(100)</td>
<td>收件方姓名</td>
</tr>
<tr>
<td>3</td>
<td>country</td>
<td>String(5)</td>
<td>收件方国家/地区，如：CN,US,JP,KR,SG,MY更多参考附录字典</td>
</tr>
<tr>
<td>4</td>
<td>postCode</td>
<td>String(20)</td>
<td>邮编</td>
</tr>
<tr>
<td>5</td>
<td>regionFirst</td>
<td>String(128)</td>
<td>收件方地址一级区划（州/省）</td>
</tr>
<tr>
<td>6</td>
<td>regionSecond</td>
<td>String(128)</td>
<td>收件方地址二级区划（城市）</td>
</tr>
<tr>
<td>7</td>
<td>regionThird</td>
<td>String(128)</td>
<td>收件方地址三级区划（区/县）</td>
</tr>
<tr>
<td>8</td>
<td>address</td>
<td>String(200)</td>
<td>收件方详细地址</td>
</tr>
<tr>
<td>9</td>
<td>regionFifth</td>
<td>String(200)</td>
<td>收件方地址五级区划（道路名，收件方国家为韩国，则必填，长度100）</td>
</tr>
<tr>
<td>10</td>
<td>regionSixth</td>
<td>String(100)</td>
<td>收件方地址六级区划（建筑编号，收件方国家为韩国，则必填）</td>
</tr>
<tr>
<td>11</td>
<td>email</td>
<td>String(128)</td>
<td>收件方邮箱</td>
</tr>
<tr>
<td>12</td>
<td>telAreaCode</td>
<td>String(10)</td>
<td>收件方固定电话区号</td>
</tr>
<tr>
<td>13</td>
<td>telNo</td>
<td>String(20)</td>
<td>收件方固定电话。收件方手机号和收件方固定电话至少填写一个</td>
</tr>
<tr>
<td>14</td>
<td>phoneAreaCode</td>
<td>String(10)</td>
<td>收件方移动电话区号</td>
</tr>
<tr>
<td>15</td>
<td>phoneNo</td>
<td>String(20)</td>
<td>收件方移动电话。收件方手机号和收件方固定电话至少填写一个</td>
</tr>
<tr>
<td>16</td>
<td>cargoType</td>
<td>INT(1)</td>
<td>收件方货物类型：1-个人件；2-公司件</td>
</tr>
<tr>
<td>17</td>
<td>certType</td>
<td>String(10)</td>
<td>收件方证件类型详细参考附录字典</td>
</tr>
<tr>
<td>18</td>
<td>certCardNo</td>
<td>String(100)</td>
<td>收件方证件号</td>
</tr>
<tr>
<td>19</td>
<td>vat</td>
<td>String(18)</td>
<td>收件方VAT号</td>
</tr>
<tr>
<td>20</td>
<td>eori</td>
<td>String(100)</td>
<td>收件方EORI号</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>CustomsInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>tradeCondition</td>
<td>String(30)</td>
<td>贸易条件，参考附录字典</td>
</tr>
<tr>
<td>2</td>
<td>senderReason</td>
<td>Int(2)</td>
<td>寄件原因：1-商业；2-非商业</td>
</tr>
<tr>
<td>3</td>
<td>senderReasonContent</td>
<td>String(256)</td>
<td>寄件原因内容</td>
</tr>
<tr>
<td>4</td>
<td>businessRemark</td>
<td>String(256)</td>
<td>商业发票备注</td>
</tr>
<tr>
<td>5</td>
<td>customsBatch</td>
<td>String(20)</td>
<td>报关批次</td>
</tr>
<tr>
<td>6</td>
<td>importCustomsType</td>
<td>String(30)</td>
<td>进口报关方式参考附录字典</td>
</tr>
<tr>
<td>7</td>
<td>exportCustomsType</td>
<td>String(30)</td>
<td>出口报关方式参考附录字典</td>
</tr>
<tr>
<td>8</td>
<td>harmonizedCode</td>
<td>String(100)</td>
<td>Harmonized Code美国寄出的可填写</td>
</tr>
<tr>
<td>9</td>
<td>aesNo</td>
<td>String(100)</td>
<td>AES No.美国寄出可填写</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>ParcelInf<strong>**o</strong></h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>name</td>
<td>String(128)</td>
<td>商品名称</td>
</tr>
<tr>
<td>2</td>
<td>eName</td>
<td>String(128)</td>
<td>商品英文名称</td>
</tr>
<tr>
<td>3</td>
<td>unit</td>
<td>String(32)</td>
<td>货物单位</td>
</tr>
<tr>
<td>4</td>
<td>amount</td>
<td>DECIMAL(24,10)</td>
<td>单价</td>
</tr>
<tr>
<td>5</td>
<td>quantity</td>
<td>DECIMAL(16,6)</td>
<td>数量</td>
</tr>
<tr>
<td>6</td>
<td>originCountry</td>
<td>String(5)</td>
<td>原产国家</td>
</tr>
<tr>
<td>7</td>
<td>hsCode</td>
<td>String(100)</td>
<td>海关编码</td>
</tr>
<tr>
<td>8</td>
<td>brand</td>
<td>String(16)</td>
<td>品牌</td>
</tr>
<tr>
<td>9</td>
<td>stateBarCode</td>
<td>String(64)</td>
<td>国条码</td>
</tr>
<tr>
<td>10</td>
<td>productCustomsNo</td>
<td>String(100)</td>
<td>海关备案号</td>
</tr>
<tr>
<td>11</td>
<td>productRecordNo</td>
<td>String(18)</td>
<td>货物产品国检备案编号</td>
</tr>
<tr>
<td>12</td>
<td>goodsCode</td>
<td>String(60)</td>
<td>商品编号</td>
</tr>
<tr>
<td>13</td>
<td>goodsUrl</td>
<td>String(2000)</td>
<td>商品链接</td>
</tr>
<tr>
<td>14</td>
<td>weight</td>
<td>DECIMAL(16,3)</td>
<td>托寄物重量</td>
</tr>
<tr>
<td>15</td>
<td>goodsDesc</td>
<td>String(200)</td>
<td>商品描述</td>
</tr>
<tr>
<td>16</td>
<td>material</td>
<td>String(600)</td>
<td>材质</td>
</tr>
<tr>
<td>17</td>
<td>specifications</td>
<td>String(64)</td>
<td>型号</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>AddServiceInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>serviceCode</td>
<td>String(32)</td>
<td>增值服务编码</td>
</tr>
<tr>
<td>2</td>
<td>value</td>
<td>String(256)</td>
<td>增值服务扩展属性</td>
</tr>
<tr>
<td>3</td>
<td>valueOne</td>
<td>String(256)</td>
<td>增值服务扩展属性1</td>
</tr>
</tbody>
</table>
<h3><strong>元素<响应>**</strong>ChildInfo**</h3>
<table>
<thead>
<tr>
<th><strong>#</strong></th>
<th><strong>属性名</strong></th>
<th><strong>类型（约束）</strong></th>
<th><strong>描述</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>sfWaybillNo</td>
<td>String(32)</td>
<td>子单编号</td>
</tr>
</tbody>
</table>
<h3><strong>明文请求示例</strong></h3>
<pre><code class="language-json">{
"companyId": "xxx",
"sfWaybillNo": "SF1324481972744"
}</code></pre>
<h3><strong>明文响应示例</strong></h3>
<pre><code class="language-json">{
"succ": "ok",
"result": {
"addServiceInfoList": [],
"childInfoList": [],
"customerOrderNo": "kts_api20210791236384012856084_CANCEL_1636965339452",
"customerOrderNoTwo": "IUOP-test2-20210219111270423144",
"customsInfo": {
"aesNo": "",
"businessRemark": "",
"customsBatch": "",
"exportCustomsType": "",
"harmonizedCode": "",
"importCustomsType": "",
"senderReasonContent": "",
"tradeCondition": ""
},
"declaredCurrency": "USD",
"declaredValue": 0.1,
"interProductCode": "",
"orderExtendInfo": {
"isSelfPick": "",
"isSignBack": "",
"signBackWaybillNo": ""
},
"parcelInfoList": [
{
"amount": 0.1,
"brand": "",
"eName": "",
"goodsCode": "",
"goodsDesc": "",
"goodsUrl": "",
"hsCode": "",
"material": "",
"name": "iPhone",
"originCountry": "SG",
"productCustomsNo": "",
"productRecordNo": "",
"quantity": 1,
"specifications": "",
"stateBarCode": "",
"unit": "个"
}
],
"parcelQuantity": 1,
"parcelTotalWeight": 0.5,
"parcelVolumeUnit": "CM",
"parcelWeightUnit": "KG",
"paymentInfo": {
"payMethod": "1",
"payMonthCard": "",
"taxPayMethod": "2",
"taxPayMonthCard": ""
},
"pickupAppointTime": "",
"pickupAppointTimeZone": "",
"pickupType": "0",
"receiverInfo": {
"address": "新加坡 详细地址",
"cargoType": 1,
"certCardNo": "",
"certType": "",
"company": "顺丰速运",
"contact": "李想",
"country": "SG",
"email": "iuop@test.com",
"eori": "",
"phoneAreaCode": "65",
"phoneNo": "54875485",
"postCode": "536727",
"regionFifth": "",
"regionFirst": "Ah Soo Walk",
"regionSecond": "106A",
"regionSixth": "",
"regionThird": "",
"telAreaCode": "86",
"telNo": "9516168888",
"vat": ""
},
"remark": "",
"senderInfo": {
"address": "306 S BRYN MAWR AVE",
"cargoType": 1,
"certCardNo": "",
"certType": "",
"company": "",
"contact": "姓名测试",
"country": "SG",
"email": "iuop@test.com",
"eori": "",
"phoneAreaCode": "65",
"phoneNo": "54875485",
"postCode": "759973",
"regionFifth": "",
"regionFirst": "Admiralty Road East",
"regionSecond": "11A",
"regionSixth": "",
"regionThird": "",
"telAreaCode": "86",
"telNo": "9516168888",
"vat": ""
},
"sfWaybillNo": "SF1324481972744"
},
"msg": ""
}</code></pre>