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