国际电子面单下单API
POST
http://api.kuaidi100.com/sendAssistant/order/apiCall通过国际快递公司或网点提供的电子面单账号,提交生成电子面单号,返回固定面单模板,调用本地打印机即可打印出电子面单。
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
partnerId | 是 | string | 月结或支付账号,详见参数字典) |
partnerName | 否 | string | 月结账号用户名,详见参数字典) |
partnerKey | 否 | string | 月结账号密钥,详见参数字典) |
partnerSecret | 否 | string | 月结账号用户密码,详见参数字典) |
code | 否 | string | 账号参数,详见字典表 |
kuaidicom | 否 | string | 快递公司的编码,一律用小写字母,见参数字典) |
ΘrecMan | 是 | recMan | 收件人信息 |
└name | 是 | string | 收件人姓名 |
└mobile | 是 | string | 收件人的手机号,手机号和电话号二者其一必填 |
└addr | 是 | string | 收件人所在完整地址 |
└district | 否 | string | 郡|县,可作为收件地址补充 |
└province | 否 | string | 州|省,可作为收件地址补充 |
└company | 否 | string | 公司名称 |
└countryCode | 是 | string | 国家代号 CN-中国 ,US-美国等, 详见参数字典) |
└city | 是 | string | 城市 |
└stateOrProvinceCode | 否 | string | 州代号:例如美国纽约州-NY |
└zipcode | 是 | string | 邮编 |
└tel | 否 | string | 电话 |
否 | string | 邮箱 | |
└taxId | 否 | string | 税号 |
└taxType | 否 | string | 纳税人类型 |
└vatNum | 否 | string | VAT税号(数字或字母);欧盟国家(含英国)使用的增值税号; |
└eoriNum | 否 | string | EORI号码(数字或字母);欧盟入关时需要EORI号码,用于商品货物的清关 |
└iossNum | 否 | string | IOSS号码 |
ΘsendMan | 是 | sendMan | 寄件人信息 |
└name | 是 | string | 寄件人姓名 |
└mobile | 是 | string | 寄件人的手机号 |
└addr | 是 | string | 寄件人所在的完整地址 |
└district | 否 | string | 郡|县,可作为寄件地址补充 |
└province | 否 | string | 州|省,可作为寄件地址补充 |
└company | 否 | string | 公司名称 |
└countryCode | 是 | string | 国家代号 CN-中国 ,US-美国等, 详见字典表 |
└city | 是 | string | 城市 |
└stateOrProvinceCode | 否 | string | 州代号:例如美国纽约州-NY |
└zipcode | 是 | string | 邮编 |
└tel | 否 | string | 电话 |
否 | string | 邮箱 | |
└taxId | 否 | string | 税号 |
└taxType | 否 | string | 纳税人类型 |
└vatNum | 否 | string | VAT税号(数字或字母);欧盟国家(含英国)使用的增值税号; |
└eoriNum | 否 | string | EORI号码(数字或字母);欧盟入关时需要EORI号码,用于商品货物的清关 |
└iossNum | 否 | string | IOSS号码 |
cargo | 否 | string | 货物描述 |
count | 否 | string | 包裹总数量,设置数量大于1时,是指同一个订单打印出多张电子面单,即同一个订单返回多个面单号,此时需要按照设置的数量N对应提供N个包裹信息(packageInfos) |
weight | 否 | string | 物品总重量 |
expType | 否 | string | 产品类型: 默认标准快递,请参考参数字典) |
remark | 否 | string | 备注 |
customsValue | 否 | Double | 申报价值,包裹类必填,货币单位根据currency确定,人民币单位是元 |
unitOfMeasurement | 否 | string | SI:千克和厘米组合;SU:磅和英寸组合,默认是SI |
tradeTerm | 是 | string | 贸易条款;CFR,DAP等,国际贸易规范用于,默认DAP |
currency | 是 | string | 货币单位,CNY-人民币;USD-美元;默认CNY |
packageInfos | 是 | Array[Object] | 包裹信息集合 |
exportInfos | 否 | Array[Object] | 出口信息集合,一般包裹类要求必填,文件类不用填,用于清关报备 |
dutiesPaymentType | 否 | Object | 关税支付方式,默认收件人支付 |
freightPaymentType | 否 | Object | 运费支付方式 |
customsClearance | 否 | Object | 清关信息 |
invoiceInfo | 否 | Object | 发票信息 |
routeId | 否 | String | 路线ID(极兔国际必填) |
needInvoice | 否 | boolean | 是否需要发票,默认false |
packageInfos数据格式 | |||
height | 否 | Double | 高度;单位厘米,默认1.0 |
width | 否 | Double | 宽度;单位厘米, 默认10.0 |
length | 否 | Double | 长度;单位厘米默认10.0 |
weight | 否 | Double | 重量; 单位千克,默认0.1 |
packageReference | 否 | string | 该包裹的备注信息之类 |
exportInfos数据格式 | |||
zhName | 否 | string | 产品中文名,chinapost、disifang必填 |
enName | 否 | string | 产品英文名,chinapost、disifang必填 |
netWeight | 否 | Double | 净重,单位kg,默认0.1 |
grossWeight | 否 | Double | 毛重,单位kg,默认 0.1 |
manufacturingCountryCode | 是 | string | 生产国代号;CN-中国,US-美国 |
unitPrice | 是 | Double | 物品单价,货币单位根据currency确定,人民币单位是元 |
quantity | 是 | Integer | 物品数量,整数,默认1 |
quantityUnitOfMeasurement | 否 | string | 计数单位,必填;PCS-件,KG-千克等,默认PCS |
desc | 否 | string | 物品描述 |
exportCommodityCode | 否 | String | 出口商品码,建议填写,加快清关速度 |
importCommodityCode | 否 | String | 进口商品码,建议填写,加快清关速度 |
dutiesPaymentType数据格式 | |||
paymentType | 否 | string | 支付方式,DDP:寄方支付;DDU:收方支付(默认) |
account | 否 | string | 账号 |
freightPaymentType数据格式 | |||
paymentType | 否 | string | 支付方式,SHIPPER:寄方付(默认);CONSIGNEE:收方付 |
account | 否 | string | 账号 |
customsClearance数据格式 | |||
purpose | 否 | String | 出口目的,请参考参数字典) |
document | 否 | boolean | 是否是文件,默认true,是文件 |
invoiceInfo数据格式 | |||
date | 是 | String | 发票日期(格式:yyyy-MM-dd)` |
number | 是 | String | 发票号 |
type | 否 | String | 发票类型,默认是商业发票 |
title | 是 | String | 发票抬头,base64字符或常规字符,不同快递公司要求不一样 |
signature | 是 | String | 发票签名(BASE64字符串) |
pltEnable | 否 | boolean | 是否启用无纸化贸易(部分快递公司支持),true-启用,false-不启用` |
注意:实际返回的字段各家快递公司不同,以实际返回为准
1.6 返回信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
500 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
1.7 支持快递公司列表
快递公司 | 编码 |
---|---|
DHL | dhl |
Fedex | fedex |
UPS | UPS |
极兔国际 | jet |
邮政国际 | chinapost |
百世国际 | baishiguoji |
递四方 | disifang |
请求参数
Body 参数application/x-www-form-urlencoded
key
string
必需
授权码,请到快递100页面申请企业版接口获取
sign
string
必需
32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台获取
t
string
必需
时间戳如:1576123932000
param
string
由其他字段拼接
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
taskId
string
任务id
message
string
返回报文描述
result
boolean
提交结果
true提交成功,false失败
status
string
返回编码
data
array [object {11}]
返回数据
面单的相关信息
pkgNums
null
包裹号,多个包裹号用英文逗号分隔
kuaidicom
string
快递公司
kuaidinum
string
快递单号
kd100OrderNum
null
可选
subNums
null
可选
invoice
null
多个发票信息集合,数据结构同invoice。fedex单包裹和多包裹都会返回,单个包裹情况返回结果一样,多个包裹情况invoices返回多个发票信息,invoice返回第一个发票信息
pdf
null
可选
labels
array [object {4}]
多个面单信息集合,数据结构同label。fedex单包裹和多包裹都会返回,单个包裹情况返回结果一样,多个包裹情况labels返回多个面单信息,label返回第一个面单信息
kuaidicom
string
可选
label
object
面单信息对象
invoices
null
可选
示例
{
"taskId": "CB61044D4A2666F4FF106EBB9D1C417D",
"message": "成功",
"result": true,
"status": "200",
"data": [
{
"pkgNums": null,
"kuaidinum": "273768921834",
"kd100OrderNum": null,
"subNums": null,
"invoice": null,
"pdf": null,
"labels": [
{
"content": "",
"fileName": "273768921834_EXP_20220601_7Q3uYO.pdf",
"type": "pdf",
"url": "https://api.kuaidi100.com/interShip/getFile?fileName=273768921834_EXP_20220601_7Q3uYO.pdf"
}
],
"kuaidicom": "fedex",
"label": {
"content": "",
"fileName": "273768921834_EXP_20220601_7Q3uYO.pdf",
"type": "pdf",
"url": "https://api.kuaidi100.com/interShip/getFile?fileName=273768921834_EXP_20220601_7Q3uYO.pdf"
},
"invoices": null
}
]
}
最后修改时间: 2 年前