国际电子面单
一、国际电子面单下单
通过国际快递公司或网点提供的电子面单账号,提交生成电子面单号,返回固定面单模板,调用本地打印机即可打印出电子面单。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
http://api.kuaidi100.com/sendAssistant/order/apiCall
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
key | 是 | string | 授权码,请到快递100页面申请企业版接口获取 |
sign | 是 | string | 32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
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 | 货物描述 |
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数据格式 | |||
netWeight | 否 | Double | 净重,单位kg,默认0.1 |
grossWeight | 否 | Double | 毛重,单位kg,默认 0.1 |
manufacturingCountryCode | 是 | string | 生产国代号;CN-中国,US-美国 |
unitPrice | 是 | Double | 物品单价,货币单位根据currency确定,人民币单位是元 |
quantity | 是 | Double | 物品数量,默认1.0 |
quantityUnitOfMeasurement | 否 | string | 计数单位,必填;PCS-件,KG-千克等,默认PCS |
desc | 否 | string | 物品描述 |
exportCommodityCode | 否 | String | 出口商品码,建议填写,加快清关速度 |
importCommodityCode | 否 | String | 进口商品码,建议填写,加快清关速度 |
dutiesPaymentType数据格式 | |||
paymentType | 否 | string | 支付方式:DDU-寄方支付;DDP-收方支付;默认DDP |
account | 否 | string | 账号 |
freightPaymentType数据格式 | |||
paymentType | 否 | string | 支付方式:SHIPPER-寄方付;CONSIGNEE-收方付 默认SHIPPER |
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.3 请求参数示例
{
"partnerId": "12344",
"partnerName": "dsfgsgs",
"partnerSecret": "dfsfsfs",
"kuaidicom": "dhl",
"sendMan": {
"name": "Kaka",
"mobile": "13500000000",
"addr": "Kingdee Software Park",
"district": "Hi-tech Park,Nanshang District",
"province": "",
"company": "QIAN HAI BAI DI",
"countryCode": "CN",
"city": "SHEN ZHEN",
"zipcode": "518057",
"tel": "0755-5890123",
"email": "12344655@qq.com",
"vatNum":"IOSS23249923",
"eoriNum":"IOSS23249923",
"iossNum":"IOSS23249923"
},
"recMan": {
"name": "Cindy Martinez / Ana Luz Medina",
"mobile": "(86)13560312000",
"addr": "Apoquindo 4001, of. 501. Las Condes",
"district": "Santiago, Chile",
"province": "",
"company": "Lamaignere Chile S.A.",
"countryCode": "CL",
"city": "Santiago",
"zipcode": "7550000",
"tel": " +56 (9) 1242355",
"email": "12344699@qq.com",
"vatNum":"IOSS23249923",
"eoriNum":"IOSS23249923",
"iossNum":"IOSS23249923"
},
"cargo": "test don't ship",
"count": "1",
"weight": "0.1",
"expType": "parcel-normal",
"remark": "just a test demo",
"packageInfos": [
{
"height": "10",
"width": "20",
"length": "11",
"weight": "0.1",
"packageReference": "just a user remark"
}
],
"exportInfos": [
{
"netWeight": 0.1,
"grossWeight": 0.1,
"manufacturingCountryCode": "CN",
"unitPrice": "10.0",
"quantity": 1.0,
"quantityUnitOfMeasurement": "PCS",
"desc": "test",
"importCommodityCode": "6109100021",
"exportCommodityCode": "6109100021",
"numberOfPieces": 1
}
],
"customsValue": "10.0",
"tradeTerm": "DAP",
"needInvoice": true,
"invoiceInfo": {
"date": "2021-08-12",
"number": "15462412",
"type": null,
"title": "test",
"signature": "base64Str",
"pltEnable": true
},
"dutiesPaymentType": {
"paymentType": "DDU",
"account": "60*****43"
},
"freightPaymentType": {
"paymentType": "SHIPPER",
"account": "60*****43"
},
"customsClearance": {
"purpose": "",
"document": true
}
}
1.4 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务id | |
code | int | 返回编码 | |
message | string | 返回报文描述 | |
data | Array[Object] | 返回数据 | 面单的相关信息 |
data数据结构
字段 | 是否相应 | 类型 | 说明 |
---|---|---|---|
kuaidinum | Y | string | 快递单号 |
pkgNums | O | string | 包裹号,多个包裹号用英文逗号分隔 |
invoice | O | Object | 发票对象信息 |
content | Y | string | 发票文件的base64字符 |
type | Y | string | 文件格式 |
url | Y | string | 文件短链接(有限期一个月) |
label | Y | Object | 面单信息对象 |
type | Y | string | 文件格式 |
url | Y | string | 文件短链接(有限期一个月) |
1.5 返回结果示例
{
"taskId": "B92D370D43E8FCC3D18F765E6135BC69",
"message": "success",
"code": 200,
"data": [
{
"pkgNums": "JD014600009041172054",
"kuaidinum": "5824672696",
"invoice": {
"content": "base64Str",
"type": "PDF",
"url": "http://ckd.im/xxx"
},
"label": {
"content": "base64Str",
"type": "pdf",
"url": "http://ckd.im/xxx"
}
}
]
}
1.6 返回结果示例
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
500 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
1.7 支持快递公司列表
快递公司 | 编码 |
---|---|
DHL | dhl |
Fedex | fedex |
UPS | UPS |
极兔国际 | jet |
邮政国际 | chinapost |
百世国际 | baishiguoji |
递四方 | disifang |
1.8 国家代号字典表
下表仅供参考,具体支持邮寄的国家以快递公司的业务范围为准
国际名称 | 国家代号 |
---|---|
中国 | CN |
印度尼西亚 | ID |
葡萄牙 | PT |
丹麦 | DK |
卢森堡 | LU |
克罗地亚 | HR |
乌克兰 | UA |
匈牙利 | HU |
美国 | US |
乌拉圭 | UY |
印度 | IN |
墨西哥 | MX |
意大利 | IT |
马来西亚 | MY |
西班牙 | ES |
阿根廷 | AR |
巴西 | BR |
智利 | CL |
哥伦比亚 | CO |
秘鲁 | PE |