| 验证信息： | ||
| devid | 由我司提供给第三方软件或网站(须正确提供DevID，如无DevID请填写EspeedPost) | |
| appid | 由我司提供给物流客户(须正确提供AppID) | |
| appkey | 由我司提供给物流客户(须正确提供AppKey，如无可留空) | |
| 未开通API的用户，请在EspeedPost中进入帐号中心->我的帐号页面，在“API帐号”下申请。 | ||
| 基本参数： | ||
| todo | 指定动作，默认为create - 创建包裹数据。 | |
| create - 创建包裹数据(缺省值) | ||
| edit - 编辑包裹数据(订单数据中须传入sn值) | ||
| delete - 删除包裹数据(订单数据中须传入sn值) | ||
| notify | 是否发送通知邮件给收件人(可选) | |
| Y - 发送(仅当传入收件人邮件地址email且客户在我司物流系统中开通了邮件通知功能时才有效) | ||
| N - 不发送(默认不发送通知邮件) | ||
| combine | 是否合并包裹数据(可选) | |
| Y - 合并(将当次传入订单数据中同一收件人的订单数据合并为一个包裹数据) | ||
| N - 不合并(默认不合并包裹数据) | ||
| errorignore | 是否忽略错误(可选) | |
| Y - 忽略(当次传入订单数据中，检测到部分数据不符合要求的，不影响其它订单数据生成包裹数据) | ||
| N - 不忽略(默认，当次传入订单数据中，检测到部分数据不符合要求的，返回错误信息，不生成包裹数据) | ||
| 寄件人信息： | ||
| sender | 寄件人信息标识(需在系统内预先创建)，若传入该值，则忽略以下寄件人参数 | |
| sendname | 寄件人姓名 | |
| sendcompany | 寄件人公司 | |
| sendaddress1 | 寄件人地址行1 | |
| sendaddress2 | 寄件人地址行2 | |
| sendcity | 寄件人城市 | |
| sendstate | 寄件人省份 | |
| sendzip | 寄件人邮编 | |
| senddestination | 寄件人国家两位代码 | |
| sendtel | 寄件人电话 | |
| 以上寄件人信息适用同批全部订单，若某个订单的寄件人信息需要单独定义，则在订单数据[orders]中进行定义 | ||
| 若未传入寄件人信息，则随机采用系统内预先创建的寄件人信息，点击进入帐号中心->控制面板管理寄件人信息 | ||
| 寄件人税号： | ||
| sendtaxnumber | 寄件人税号 | |
| sendtaxtype | 寄件人税号类型 | |
| 0 - IOSS | ||
| 1 - non-IOSS | ||
| 2 - 其它 | ||
| 以上寄件人信息适用同批全部订单，若某个订单的寄件人税号需要单独定义，则在订单数据[orders]中进行定义 | ||
| 订单数据： | ||
| status | 数据初始状态(可选) | |
| 2 - 已经确认(默认，订单数据传入时数据状态设为“已经确认”并分配跟踪条码(如有)) | ||
| 1 - 未经确认(订单数据传入时数据状态设为“未经确认”) | ||
| format | 订单数据格式，默认为JSON格式。 | |
| json - JSON格式数据，默认 | ||
| xml - XML格式数据 | ||
| orders | 订单数据集合。如果一次只传入一个订单数据，也可以忽略该值，直接传入订单参数(同之前版本一样)。 | |
| JSON格式：{"order":[{订单1},{订单2},{订单3},...,{订单n}]}。每个{订单}数据的具体格式为{"参数1":"值","参数2":"值","参数3":"值",...,"参数n":"值"}。如果参数值包含有多项数据的，则{订单}格式为{"参数1":["数据1","数据2","数据3",...,"数据n"],"参数2":"值","参数3":["数据1","数据2","数据3",...,"数据n"],...,"参数n":"值"} | ||
| XML格式：<orders><order>订单1</order><order>订单2</order><order>订单3</order>...</orders>。每个<order>订单</order>数据的具体格式为<order><参数1>值</参数1><参数2>值</参数2><参数3>值</参数3>...</order>。如果参数值包含有多项数据的，则<order>订单</order>数据的具体格式为<order><参数1><参数1_1>值</参数1_1><参数1_2>值</参数1_2><参数1_3>值</参数1_3>...</参数1><参数2><参数2_1>值</参数2_1><参数2_2>值</参数2_2><参数2_3>值</参数2_3>...</参数2>...</order> | ||
| 每个订单数据的详细参数如下： | ||
| 订单参数： | ||
| no | 客户自定义包裹号(可选)，同一帐户下，该值不允许重复 | |
| sn | 包裹编号(可选)，创建包裹时该值被忽略；编辑、删除包裹数据时必须传入该值 | |
| ordernumber | 订单号(可选) | |
| method | 运输方式(如CNA、CNR、HKD、HKU等) | |
| service | 服务类别(默认为BGA) | |
| 运输方式和服务类别也可合并为methodservice传入，两值以"-"相连，例如HKD-BGA | ||
| EspeedPost运输服务代码请查阅:http://api.espeedpost.com/methodservice | ||
| cptype | 产品类别(须如实申报产品类别，默认为普货) | |
| 00 - 普货 | ||
| ND - 内电 | ||
| PD - 配电 | ||
| CD - 纯电 | ||
| DP - 带牌 | ||
| FY - 防疫 | ||
| sellerid | 卖家ID(可选) | |
| buyerid | 买家ID(可选) | |
| ebayid | 卖家的eBay用户名(可选) | |
| ebaysalesrecordnumber | 卖家的eBay销售记录号(可选) | |
| ebayorderid | 卖家的eBay订单号(可选) | |
| ebaytransactionid | 卖家的eBay交易号(可选) | |
| 传入上述4个值后客户可使用我司系统自动标记发货功能(仅针对eBay平台订单) | ||
| paypaltransactionid | PayPal交易号(可选) | |
| itemid | 销售平台产品编号(可选) | |
| 如果有多个itemid，JSON格式为{"itemid":["数据1",...,"数据n"]}或{"itemid":{"itemid_1":"数据1","itemid_2":"数据2"..."itemid_n":"数据n"}}，XML格式为<itemid><itemid_1>数据1</itemid_1><itemid_2>数据2</itemid_2>...<itemid_n>数据n</itemid_n></itemid>，最多允许10个值。 | ||
| itemtitle | 销售平台产品标题(可选) | |
| 如果有多个itemtitle，格式参考itemid的格式。 | ||
| itemcount | 销售平台产品数量(可选) | |
| 如果有多个itemcount，格式参考itemid的格式。 | ||
| itemlabel | 自定义产品代码(可选，类似eBay中的Custom Label值，该字段名称也可以是“label”、“sku” 或 “itemsku”) | |
| 如果有多个itemlabel，格式参考itemid的格式。 | ||
| 产品代码可显示在打印出来的地址标签上,便于打包时拣选物品 | ||
| 以上产品信息(配货信息)也可以按如下格式提交： | ||
| {"item":
[ {"itemid":"","itemtitle":"","itemcount":"","itemlabel":""}, {"itemid":"","itemtitle":"","itemcount":"","itemlabel":""}, ... ] } |
||
| category | 申报类别(可选,默认为G-礼物) | |
| G - 礼物 | ||
| D - 文件 | ||
| S - 商用样本 | ||
| O - 其它 | ||
| categorycontent | 申报类别名称(可选) | |
| 当category值为O-其它时，应传入该值,默认为"Other" | ||
| description | 英文申报名称(挂号、快递件必选，长度限制30个字符内) | |
| 如果有多个申报名称，格式参考itemid的格式，最多允许4个值。 | ||
| description_cn | 中文申报名称(建议填写，中邮渠道必填) | |
| 如果有多个申报名称，格式参考itemid的格式，最多允许4个值。 | ||
| hscode | 海关编码 | |
| 如果有多个与申报名称对应的海关编码，格式参考itemid的格式，最多允许4个值。 | ||
| material | 商品材质 | |
| 如果有多个与申报名称对应的商品材质，格式参考itemid的格式，最多允许4个值。 | ||
| usefor | 商品用途 | |
| 如果有多个与申报名称对应的商品用途，格式参考itemid的格式，最多允许4个值。 | ||
| quantity | 申报数量(挂号、快递件必选,默认为1) | |
| 如果有多个与申报名称对应的申报数量，格式参考itemid的格式，最多允许4个值。 | ||
| weight1 | 申报重量(总重量，不是单重！单位为公斤(KG)，挂号、快递件必选，默认为0.1KG) | |
| 如果有多个与申报名称对应的申报重量，格式参考itemid的格式，最多允许4个值。 | ||
| value1 | 申报价值(总价值，不是单价！挂号、快递件必选，默认为10美元) | |
| 如果有多个与申报名称对应的申报价值，格式参考itemid的格式，最多允许4个值。 | ||
| 以上申报内容也可以按如下格式提交： | ||
| {"declaration":
[ {"description":"","description_cn":"","hscode":"","material":"","usefor":"","quantity":"","weight1":"","value1":""}, {"description":"","description_cn":"","hscode":"","material":"","usefor":"","quantity":"","weight1":"","value1":""}, ... ] } |
||
| money | 申报价值货币单位三位代码(默认为USD) | |
| 美元 - USD | ||
| 英镑 - GBP | ||
| 欧元 - EUR | ||
| 加元 - CAD | ||
| 澳元 - AUD | ||
| sendtaxnumber | 寄件人税号(适用当前订单) | |
| sendtaxtype | 寄件人税号类型 | |
| 0 - IOSS | ||
| 1 - non-IOSS | ||
| 2 - 其它 | ||
| recipient | 收件人姓名（注：JSON格式数据也可传入name；XML格式必须传入recipient或fullname，不能使用name作为节点名称） | |
| company | 收件人公司 | |
| taxnumber | 收件人税号 | |
| address1 | 收件人地址行1 | |
| address2 | 收件人地址行2(可选) | |
| city | 收件人城市 | |
| state | 收件人省份/州 | |
| zip | 收件人邮编(如有) | |
| tel | 收件人电话(国际快递件DHL、UPS、Fedex必选) | |
| mobile | 收件人手机号(可选) | |
| destination | 目的国家两位代码 | |
| 如未提供综合地址(address)，必须提供分解地址(address1,address2,city,state,zip,tel等) | ||
| 如提供了完整的分解地址，可省略综合地址，由系统自动生成 | ||
| 发往US,CA,AU,JP,IN等国家的香港邮政国际小包(HKA,HKR)必须单独传入邮编(zip)用于分区 | ||
| 国际快递件(DHL,UPS,Fedex)必须单独传入收件人电话(tel) | ||
| 香港邮政挂号包裹(HKR)地址单行长度不能超过60个字符,行数不能超过5行 | ||
| 收件人电子邮件地址(可选) | ||
| stock | 是否库存发货(可选) | |
| 若库存发货,传入"Y",默认为"N"。 | ||
| insured | 是否购买保险(可选) | |
| 若购买保险,传入"Y",默认为"N"。目前仅针对香港挂号提供保险服务。 | ||
| ifreturn | 是否需要退件(可选) | |
| 默认为"Y"-需要退件。若放弃退件,传入"N"。 | ||
| trackingnumber | 跟踪条码(可选，如需要由系统自动分配，该值请留空) | |
| 跟踪条码指承运商跟踪条码，如邮政挂号条码、国际快递运单号等，一般由我司系统自动生成或操作人员收寄包裹时录入 | ||
| note | 备注信息(可选) | |
| result | 数据添加结果：成功返回'success'，失败返回'failure'，部分成功返回'warning'，错误返回'error' | |
| message | 返回提示信息 | |
| errorCode - 错误代码 http://api.espeedpost.com/shipping/shipping.errorcode.html | ||
| errorMsg - 错误详情 | ||
| sn | 返回包裹编号（创建包裹时返回新建包裹编号、编辑或删除包裹时返回对应包裹编号） | |
| trackingnumber | 返回包裹跟踪条码 | |
| zone | 目的国家所属分区（如有） | |
| summary | 返回综合操作结果 | |
| detail | 返回详细操作结果 |