运单王对外开放API接口

API接口


一键购买

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>一键购入</li> </ul> <h5>请求URL</h5> <p>-正式版:<a href="https://ydw.ec-return.com/api/user/capi/index">https://ydw.ec-return.com/api/user/capi/index</a> 沙盒版:<a href="http://sandbox-ydw.ec-return.com/api/user/capi/index">http://sandbox-ydw.ec-return.com/api/user/capi/index</a></p> <h5>请求方式</h5> <ul> <li>JSON </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>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">user_login</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>your user name</td> </tr> <tr> <td style="text-align: left;">access_code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>your access code</td> </tr> <tr> <td style="text-align: left;">order_source</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>your system code</td> </tr> <tr> <td style="text-align: left;">carrierName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>指定的物流公司名称</td> </tr> <tr> <td style="text-align: left;">serviceName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>指定的物流服务名称</td> </tr> <tr> <td style="text-align: left;">LogisticChannel</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>指定的物流渠道名称,具体名称请咨询运单王技术客服。注:LogisticChannel与carrierName为二选一,carrierName优先于LogisticChannel如果二者都被指定,LogisticChannel视为无效</td> </tr> <tr> <td style="text-align: left;">ECOrderNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>销售平台订单号</td> </tr> <tr> <td style="text-align: left;">WareHouseTaskNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>仓库出库单号</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;zip&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>发货邮编 按各国邮编格式</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;attention&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>发货人attention(可选)</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;company&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>发货人</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;address1&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>地址1</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;address2&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>地址2(可选)</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;city&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>发货城市</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;state&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>发货省份代码(2位字母)</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;country&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>发货国家代码(2位字母)</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;phone&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>发货电话(10位数字)</td> </tr> <tr> <td style="text-align: left;">data[&#039;from&#039;][][&#039;instructions&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>发货人备注(可选)</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;zip&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货邮编</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;company&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货人</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;attention&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>收货人attention(可用来填写货物代码 例sku序号)</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;address1&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货地址1</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;address2&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>收货地址2(可选))</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;city&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货城市</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;state&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货省份(2位字母)</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;country&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货国家代码(2位字母)</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;phone&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>收货电话(10位数字)</td> </tr> <tr> <td style="text-align: left;">data[&#039;to&#039;][][&#039;instructions&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>收货人备注(可选)</td> </tr> <tr> <td style="text-align: left;">package_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>Package:快递, Pallet:LTL卡派)</td> </tr> <tr> <td style="text-align: left;">data[&#039;package&#039;][][&#039;length&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>包裹长(快递)托盘长(LTL卡派)</td> </tr> <tr> <td style="text-align: left;">data[&#039;package&#039;][][&#039;width&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>包裹宽(快递)托盘宽(LTL卡派)</td> </tr> <tr> <td style="text-align: left;">data[&#039;package&#039;][][&#039;height&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>包裹高(快递)托盘高(LTL卡派)</td> </tr> <tr> <td style="text-align: left;">data[&#039;package&#039;][][&#039;weight&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>包裹重(快递)托盘重(LTL卡派)</td> </tr> <tr> <td style="text-align: left;">data[&#039;package&#039;][][&#039;description&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>包裹描述(快递)托盘描述(LTL卡派)</td> </tr> <tr> <td style="text-align: left;">data[&#039;package&#039;][][&#039;DG_ID&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>运单王危险品ID(可选 可不填)</td> </tr> <tr> <td style="text-align: left;">signatureRequired</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>要求签名服务 no,yes(DIRECT),adult</td> </tr> <tr> <td style="text-align: left;">SpecialInstruction</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>其他特殊要求(卡派)</td> </tr> <tr> <td style="text-align: left;">insurance</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>保险金额(保价区间为CAD$100-1600(含边界),如果一单为多个包裹时,报价被平均分配给每个包裹)</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;currency&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>币种缩写:USD,CAD</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;ReasonForExport&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>出口理由缩写,必须是以下关键字:SALE,GIFT,SAMPLE,RETURN,REPAIR,INTERCOMPANYDATA</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;company&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>公司名称</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;name&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>联系人名</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;address1&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>地址1</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;address2&#039;]</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td>地址二</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;city&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>所在城市</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;state&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>所在省份</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;zip&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>邮编</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;country&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>国家代码缩写:CA,US</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;phone&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>联系人电话</td> </tr> <tr> <td style="text-align: left;">data[&#039;bill_to&#039;][&#039;email&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>联系人邮箱</td> </tr> <tr> <td style="text-align: left;">data[&#039;product_list&#039;][&#039;description&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>产品名称 英文</td> </tr> <tr> <td style="text-align: left;">data[&#039;product_list&#039;][&#039;code&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>HSCODE</td> </tr> <tr> <td style="text-align: left;">data[&#039;product_list&#039;][&#039;originCountry&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>原产国名称缩写:CA,US,CN</td> </tr> <tr> <td style="text-align: left;">data[&#039;product_list&#039;][&#039;number&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>产品个数(所有包裹里的合计)</td> </tr> <tr> <td style="text-align: left;">data[&#039;product_list&#039;][&#039;price&#039;]</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>产品单价</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>{ &amp;quot;reqdata_type&amp;quot;: &amp;quot;请求数据类型 json,无:post data&amp;quot;, &amp;quot;format&amp;quot;: &amp;quot;响应数据类型json,xml&amp;quot;, &amp;quot;func&amp;quot;: &amp;quot;API功能定义:onestepbuy&amp;quot;, &amp;quot;user_login&amp;quot;: &amp;quot;your user name&amp;quot;, &amp;quot;access_code&amp;quot;: &amp;quot;your access code&amp;quot;, &amp;quot;order_customer&amp;quot;: &amp;quot;your customer code&amp;quot;, &amp;quot;order_source&amp;quot;: &amp;quot;your system code&amp;quot;, &amp;quot;carrierName&amp;quot;: &amp;quot;指定的物流公司名称&amp;quot;, &amp;quot;serviceName&amp;quot;: &amp;quot;指定的物流服务名称&amp;quot;, &amp;quot;LogisticChannel&amp;quot;: &amp;quot;指定的物流渠道名称,具体名称请咨询运单王技术客服,注:LogisticChannel与carrierName为二选一,carrierName优先于LogisticChannel如果二者都被指定,LogisticChannel视为无效&amp;quot;, &amp;quot;ECOrderNo&amp;quot;: &amp;quot;销售平台订单号&amp;quot;, &amp;quot;WareHouseTaskNo&amp;quot;: &amp;quot;仓库出库单号&amp;quot;, &amp;quot;from&amp;quot;: { &amp;quot;0:发货信息数组0-4(最大支持5个发货地比价)&amp;quot;: { &amp;quot;zip&amp;quot;: &amp;quot;发货邮编&amp;quot;, &amp;quot;attention&amp;quot;: &amp;quot;发货人attention(可选)&amp;quot;, &amp;quot;company&amp;quot;: &amp;quot;发货人&amp;quot;, &amp;quot;address1&amp;quot;: &amp;quot;地址1&amp;quot;, &amp;quot;address2&amp;quot;: &amp;quot;地址2(可选)&amp;quot;, &amp;quot;city&amp;quot;: &amp;quot;发货城市&amp;quot;, &amp;quot;state&amp;quot;: &amp;quot;发货省份代码(2位字母)&amp;quot;, &amp;quot;country&amp;quot;: &amp;quot;发货国家代码(2位字母)&amp;quot;, &amp;quot;phone&amp;quot;: &amp;quot;发货电话(10位数字)01230001122&amp;quot;, &amp;quot;instructions&amp;quot;: &amp;quot;发货人备注(可选)&amp;quot; } }, &amp;quot;to&amp;quot;: { &amp;quot;zip&amp;quot;: &amp;quot;收货邮编&amp;quot;, &amp;quot;company&amp;quot;: &amp;quot;收货人&amp;quot;, &amp;quot;attention&amp;quot;: &amp;quot;收货人attention(可用来填写货物代码 例sku序号)&amp;quot;, &amp;quot;address1&amp;quot;: &amp;quot;收货地址1&amp;quot;, &amp;quot;address2&amp;quot;: &amp;quot;收货地址2(可选)&amp;quot;, &amp;quot;city&amp;quot;: &amp;quot;收货城市(2位字母)&amp;quot;, &amp;quot;state&amp;quot;: &amp;quot;收货省份(2位字母)&amp;quot;, &amp;quot;country&amp;quot;: &amp;quot;收货国家代码(2位字母)&amp;quot;, &amp;quot;phone&amp;quot;: &amp;quot;收货电话(10位数字)01230001122&amp;quot;, &amp;quot;instructions&amp;quot;: &amp;quot;收货人备注(可选)&amp;quot; }, &amp;quot;package_type&amp;quot;: &amp;quot;Package:快递,Pallet:LTL卡派&amp;quot;, &amp;quot;package&amp;quot;: { &amp;quot;0:包裹数组(快递)托盘数组(LTL卡派)&amp;quot;: { &amp;quot;length&amp;quot;: &amp;quot;包裹长(快递)托盘长(LTL卡派)&amp;quot;, &amp;quot;width&amp;quot;: &amp;quot;包裹宽(快递)托盘宽(LTL卡派)&amp;quot;, &amp;quot;height&amp;quot;: &amp;quot;包裹高(快递)托盘高(LTL卡派)&amp;quot;, &amp;quot;weight&amp;quot;: &amp;quot;包裹重(快递)托盘重(LTL卡派)&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;包裹描述(快递)托盘描述(LTL卡派)&amp;quot;, &amp;quot;DG_ID&amp;quot;: &amp;quot;运单王危险品ID(可选 可不填)&amp;quot; } }, &amp;quot;signatureRequired&amp;quot;: &amp;quot;要求签名服务 no,yes(DIRECT),adult&amp;quot;, &amp;quot;SpecialInstruction&amp;quot;: &amp;quot;其他特殊要求(卡派)&amp;quot;, &amp;quot;insurance&amp;quot;: &amp;quot;保险金额(保价区间为CAD$100-1600(含边界),如果一单为多个包裹时,报价被平均分配给每个包裹)&amp;quot;, &amp;quot;bill_to&amp;quot;: { &amp;quot;currency&amp;quot;: &amp;quot;币种缩写:USD,CAD&amp;quot;, &amp;quot;ReasonForExport&amp;quot;: &amp;quot;出口理由缩写,必须是以下关键字:SALE,GIFT,SAMPLE,RETURN,REPAIR,INTERCOMPANYDATA&amp;quot;, &amp;quot;company&amp;quot;: &amp;quot;公司名称&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;联系人名&amp;quot;, &amp;quot;address1&amp;quot;: &amp;quot;地址1&amp;quot;, &amp;quot;address2&amp;quot;: &amp;quot;地址2&amp;quot;, &amp;quot;city&amp;quot;: &amp;quot;所在城市&amp;quot;, &amp;quot;state&amp;quot;: &amp;quot;所在省份&amp;quot;, &amp;quot;zip&amp;quot;: &amp;quot;邮编&amp;quot;, &amp;quot;country&amp;quot;: &amp;quot;国家代码缩写:CA,US&amp;quot;, &amp;quot;phone&amp;quot;: &amp;quot;联系人电话&amp;quot;, &amp;quot;email&amp;quot;: &amp;quot;联系人邮箱&amp;quot;, &amp;quot;product_list&amp;quot;: [ { &amp;quot;description&amp;quot;: &amp;quot;产品名称 英文&amp;quot;, &amp;quot;code&amp;quot;: &amp;quot;HSCODE&amp;quot;, &amp;quot;originCountry&amp;quot;: &amp;quot;原产国名称缩写:CA,US,CN&amp;quot;, &amp;quot;number&amp;quot;: &amp;quot;产品个数(所有包裹里的合计)&amp;quot;, &amp;quot;price&amp;quot;: &amp;quot;产品单价&amp;quot; } ] } }</code></pre> <h5>返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: &amp;quot;成功: 0,失败: 1&amp;quot;, &amp;quot;server_type_str&amp;quot;: &amp;quot;沙盒,正式&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;成功:Success,失败:Error&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;status&amp;quot;: &amp;quot;0:查询成功,1:未支付,2:已支付,3:部分退款,4:已退款,5:已过期,6:已取消,7-99:未知状态,100:请输入临时订单号,101:请输入用户,102:查无此单,103:未创建订单或临时订单号无效 .(1,2需定期查询)&amp;quot;, &amp;quot;cache_id&amp;quot;: &amp;quot;临时订单号&amp;quot;, &amp;quot;user_id&amp;quot;: &amp;quot;your user id&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;查询成功&amp;quot;, &amp;quot;data&amp;quot;: [ { &amp;quot;tracking_number&amp;quot;: &amp;quot;追踪号&amp;quot;, &amp;quot;order_id&amp;quot;: &amp;quot;订单号&amp;quot;, &amp;quot;cache_id&amp;quot;: &amp;quot;临时订单号&amp;quot;, &amp;quot;add_time&amp;quot;: &amp;quot;创建时间&amp;quot;, &amp;quot;status&amp;quot;: 1, &amp;quot;carrier&amp;quot;: &amp;quot;承运商名称&amp;quot;, &amp;quot;waybill-url&amp;quot;: &amp;quot;运单下载URL&amp;quot; } ] } }</code></pre>

页面列表

ITEM_HTML