派通国际物流 API接口文档说明

派通国际物流 API接口文档说明


创建订单

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>创建订单</li> </ul> <h5>请求URL</h5> <ul> <li>请求头需要加入api-key参数,详情请看签名方式页面</li> <li><code>https://api.patuen.com/print/create</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>请求</h5> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">是否必须</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">customerOrderNo</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">客户出库单号</td> </tr> <tr> <td style="text-align: left;">logisticsProductCode</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">渠道代码</td> </tr> <tr> <td style="text-align: left;">packageLengthD</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Double(10.1)</td> <td style="text-align: left;">包裹长度(CM)</td> </tr> <tr> <td style="text-align: left;">packageWidthD</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Double(10.1)</td> <td style="text-align: left;">包裹宽度(CM)</td> </tr> <tr> <td style="text-align: left;">packageHeightD</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Double(10.1)</td> <td style="text-align: left;">包裹高度(CM)</td> </tr> <tr> <td style="text-align: left;">packageWeightD</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Double(10.3)</td> <td style="text-align: left;">包裹重量(KG)</td> </tr> <tr> <td style="text-align: left;">goodsCategory</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Number</td> <td style="text-align: left;">货品类型 11-礼物,12-文件,13-商业样品,14-回货品,15-其他</td> </tr> <tr> <td style="text-align: left;">labelRemark</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">面单备注</td> </tr> <tr> <td style="text-align: left;">warehouseCode</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">外部仓库编码</td> </tr> <tr> <td style="text-align: left;">shipper</td> <td style="text-align: left;"></td> <td style="text-align: left;">Object</td> <td style="text-align: left;">发件信息</td> </tr> <tr> <td style="text-align: left;">consignee</td> <td style="text-align: left;"></td> <td style="text-align: left;">Object</td> <td style="text-align: left;">收件信息</td> </tr> <tr> <td style="text-align: left;">declaration</td> <td style="text-align: left;"></td> <td style="text-align: left;">List</td> <td style="text-align: left;">申报信息</td> </tr> </tbody> </table> <table> <thead> <tr> <th style="text-align: left;">shipper</th> <th style="text-align: left;"></th> <th style="text-align: left;">Object</th> <th style="text-align: left;">发件信息</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">shipperName</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">姓名</td> </tr> <tr> <td style="text-align: left;">shipperCompany</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">公司</td> </tr> <tr> <td style="text-align: left;">shipperEmail</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">邮箱</td> </tr> <tr> <td style="text-align: left;">shipperCountry</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">国家简码(选项:US-美国, CN-中国)</td> </tr> <tr> <td style="text-align: left;">shipperProvince</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">省份/州</td> </tr> <tr> <td style="text-align: left;">shipperCity</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">城市</td> </tr> <tr> <td style="text-align: left;">shipperPostcode</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">邮政编码</td> </tr> <tr> <td style="text-align: left;">shipperPhone</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">电话</td> </tr> <tr> <td style="text-align: left;">shipperAddress</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">地址</td> </tr> <tr> <td style="text-align: left;">shipperDoorplate</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">门牌/单位</td> </tr> </tbody> </table> <table> <thead> <tr> <th style="text-align: left;">consignee</th> <th style="text-align: left;"></th> <th style="text-align: left;">Object</th> <th style="text-align: left;">收件信息</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">consigneeName</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人姓名</td> </tr> <tr> <td style="text-align: left;">consigneeCompany</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人公司</td> </tr> <tr> <td style="text-align: left;">consigneeEmail</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人邮箱</td> </tr> <tr> <td style="text-align: left;">consigneeCountry</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人国家简码(选项:US-美国, CN-中国)</td> </tr> <tr> <td style="text-align: left;">consigneeProvince</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人省份/州</td> </tr> <tr> <td style="text-align: left;">consigneeCity</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人城市</td> </tr> <tr> <td style="text-align: left;">consigneePostcode</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人邮政编码</td> </tr> <tr> <td style="text-align: left;">consigneePhone</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人电话</td> </tr> <tr> <td style="text-align: left;">consigneeAddress</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人地址</td> </tr> <tr> <td style="text-align: left;">consigneeDoorplate</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">收货人门牌/单位</td> </tr> </tbody> </table> <table> <thead> <tr> <th style="text-align: left;">declaration</th> <th style="text-align: left;"></th> <th style="text-align: left;">list</th> <th style="text-align: left;">申报信息</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">englishName</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">英文品名</td> </tr> <tr> <td style="text-align: left;">chineseName</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">中文品名</td> </tr> <tr> <td style="text-align: left;">quantity</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">数量</td> </tr> <tr> <td style="text-align: left;">unitNetWeightD</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Double(10.3)</td> <td style="text-align: left;">产品重量</td> </tr> <tr> <td style="text-align: left;">unitDeclarePriceD</td> <td style="text-align: left;">必选</td> <td style="text-align: left;">Double(10.2)</td> <td style="text-align: left;">申报单价</td> </tr> <tr> <td style="text-align: left;">hsCode</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">海关编码</td> </tr> <tr> <td style="text-align: left;">sku</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">sku</td> </tr> <tr> <td style="text-align: left;">origin</td> <td style="text-align: left;">非必选</td> <td style="text-align: left;">String</td> <td style="text-align: left;">原产地</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>{ &amp;quot;goodsCategory&amp;quot;: 货物类型, &amp;quot;shipper&amp;quot;: { &amp;quot;shipperName&amp;quot;: &amp;quot;姓名&amp;quot;, &amp;quot;shipperCompany&amp;quot;: &amp;quot;公司&amp;quot;, &amp;quot;shipperEmail&amp;quot;: &amp;quot;邮箱&amp;quot;, &amp;quot;shipperCountry&amp;quot;: &amp;quot;国家(选项:US-美国, CN-中国)&amp;quot;, &amp;quot;shipperProvince&amp;quot;: &amp;quot;省份/州&amp;quot;, &amp;quot;shipperCity&amp;quot;: &amp;quot;城市&amp;quot;, &amp;quot;shipperPostcode&amp;quot;: &amp;quot;邮政编码&amp;quot;, &amp;quot;shipperPhone&amp;quot;: &amp;quot;电话&amp;quot;, &amp;quot;shipperAddress&amp;quot;: &amp;quot;地址&amp;quot;, &amp;quot;shipperDoorplate&amp;quot;: &amp;quot;门牌/单位&amp;quot;, }, &amp;quot;consignee&amp;quot;: { &amp;quot;consigneeName&amp;quot;: &amp;quot;收货人姓名&amp;quot;, &amp;quot;consigneeCompany&amp;quot;: &amp;quot;收货人公司&amp;quot;, &amp;quot;consigneeEmail&amp;quot;: &amp;quot;收货人邮箱&amp;quot;, &amp;quot;consigneeCountry&amp;quot;: &amp;quot;收货人国家(选项:US-美国, CN-中国)&amp;quot;, &amp;quot;consigneeProvince&amp;quot;: &amp;quot;收货人省份/州&amp;quot;, &amp;quot;consigneeCity&amp;quot;: &amp;quot;收货人城市&amp;quot;, &amp;quot;consigneePostcode&amp;quot;: &amp;quot;收货人邮政编码&amp;quot;, &amp;quot;consigneePhone&amp;quot;: &amp;quot;收货人电话&amp;quot;, &amp;quot;consigneeAddress&amp;quot;: &amp;quot;收货人地址&amp;quot;, &amp;quot;consigneeDoorplate&amp;quot;: &amp;quot;收货人门牌/单位&amp;quot; }, &amp;quot;declaration&amp;quot;: [ { &amp;quot;chineseName&amp;quot;: &amp;quot;中文品名&amp;quot;, &amp;quot;englishName&amp;quot;: &amp;quot;英文品名&amp;quot;, &amp;quot;hsCode&amp;quot;: &amp;quot;海关编码&amp;quot;, &amp;quot;unitDeclarePriceD&amp;quot;: &amp;quot;申报单价&amp;quot;, &amp;quot;unitNetWeightD&amp;quot;: &amp;quot;产品重量&amp;quot;, &amp;quot;quantity&amp;quot;: &amp;quot;数量&amp;quot; } ], &amp;quot;customerOrderNo&amp;quot;: &amp;quot;单号&amp;quot;, &amp;quot;logisticsProductCode&amp;quot;: &amp;quot;渠道&amp;quot;, &amp;quot;packageWeightD&amp;quot;: &amp;quot;重量&amp;quot;, &amp;quot;packageLengthD&amp;quot;: &amp;quot;长&amp;quot;, &amp;quot;packageWidthD&amp;quot;: &amp;quot;宽&amp;quot;, &amp;quot;packageHeightD&amp;quot;: &amp;quot;高&amp;quot;, &amp;quot;warehouseCode&amp;quot;: &amp;quot;外部仓库编码&amp;quot; }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">Body</td> <td style="text-align: left;"></td> <td style="text-align: left;">响应体</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">String</td> <td style="text-align: left;">状态码 0</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">String</td> <td style="text-align: left;">响应信息</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">Object</td> <td style="text-align: left;"></td> </tr> <tr> <td style="text-align: left;">customerOrderNo</td> <td style="text-align: left;">String</td> <td style="text-align: left;">客户单号</td> </tr> <tr> <td style="text-align: left;">wayBillNo</td> <td style="text-align: left;">String</td> <td style="text-align: left;">运单号</td> </tr> <tr> <td style="text-align: left;">deliveryNo</td> <td style="text-align: left;">String</td> <td style="text-align: left;">派送单号</td> </tr> <tr> <td style="text-align: left;">labelUrl</td> <td style="text-align: left;">String</td> <td style="text-align: left;">面单下载地址</td> </tr> <tr> <td style="text-align: left;">codeUrl</td> <td style="text-align: left;">String</td> <td style="text-align: left;">条形码标签下载地址</td> </tr> <tr> <td style="text-align: left;">payFee</td> <td style="text-align: left;">String</td> <td style="text-align: left;">支付费用</td> </tr> <tr> <td style="text-align: left;">currency</td> <td style="text-align: left;">String</td> <td style="text-align: left;">币种,如:USD</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 0, &amp;quot;msg&amp;quot;: &amp;quot;操作成功&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;customerOrderNo&amp;quot;: &amp;quot;OT1251918SS&amp;quot;, &amp;quot;wayBillNo&amp;quot;: &amp;quot;PT06250225212736107412&amp;quot;, &amp;quot;bindNo&amp;quot;: &amp;quot;ZP01448918101&amp;quot;, &amp;quot;deliveryNo&amp;quot;: &amp;quot;9400110805517341607543&amp;quot; , &amp;quot;labelUrl&amp;quot;: &amp;quot;http://8.134.56.151/its-api/files/20250224/a4d3fe33beed41f3b5f52ec358c4de98.pdf&amp;quot; , &amp;quot;codeUrl&amp;quot;: &amp;quot;https://api.patuen.com/static/a23ggs354gh.pdf&amp;quot; , &amp;quot;payFee&amp;quot;: &amp;quot;1.0&amp;quot; , &amp;quot;currency&amp;quot;: &amp;quot;USD&amp;quot; , } }</code></pre> <h5>失败返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 500, &amp;quot;msg&amp;quot;: &amp;quot;客户订单号:OT1251918SS已经存在&amp;quot;, &amp;quot;data&amp;quot;: {} }</code></pre> <h5>备注</h5> <ul> <li>有其他问题请联系管理员</li> </ul>

页面列表

ITEM_HTML