文档中心
国际电子面单下单

国际电子面单

一、国际电子面单下单

通过国际快递公司或网点提供的电子面单账号,提交生成电子面单号,返回固定面单模板,调用本地打印机即可打印出电子面单。

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

http://poll.kuaidi100.com/eorderapi.do

请求参数(header)

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(body)

参数名是否必填类型说明
methodstring业务类型(默认:intership)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
partnerIdstring月结或支付账号
partnerNamestring月结账号用户名
partnerKeystring月结账号密钥
partnerSecretstring月结账号用户密码
kuaidicomstring快递公司的编码,一律用小写字母,见参数字典
ΘrecManrecMan收件人信息
¬namestring收件人姓名
¬mobilestring收件人的手机号,手机号和电话号二者其一必填
¬addrstring收件人所在完整地址
¬districtstring郡|县,可作为收件地址补充
¬provincestring州|省,可作为收件地址补充
¬companystring公司名称
¬countryCodestring国家代号 CN-中国 ,US-美国等, 详见字典表
¬citystring城市
¬stateOrProvinceCodestring州代号:例如美国纽约州-NY
¬zipcodestring邮编
¬telstring电话
¬emailstring邮箱
¬taxIdstring税号
¬taxTypestring纳税人类型
¬vatNumstringVAT税号(数字或字母);欧盟国家(含英国)使用的增值税号;
¬eoriNumstringEORI号码(数字或字母);欧盟入关时需要EORI号码,用于商品货物的清关
¬iossNumstringIOSS号码
ΘsendMansendMan寄件人信息
¬namestring寄件人姓名
¬mobilestring寄件人的手机号
¬addrstring寄件人所在的完整地址
¬districtstring郡|县,可作为收件地址补充
¬provincestring州|省,可作为收件地址补充
¬companystring公司名称
¬countryCodestring国家代号 CN-中国 ,US-美国等, 详见字典表
¬citystring城市
¬stateOrProvinceCodestring州代号:例如美国纽约州-NY
¬zipcodestring邮编
¬telstring电话
¬emailstring邮箱
¬taxIdstring税号
¬taxTypestring纳税人类型
¬vatNumstringVAT税号(数字或字母);欧盟国家(含英国)使用的增值税号;
¬eoriNumstringEORI号码(数字或字母);欧盟入关时需要EORI号码,用于商品货物的清关
¬iossNumstringIOSS号码
cargostring货物描述
weightstring物品总重量
expTypestring产品类型: 默认标准快递,请参考参数字典
remarkstring备注
customsValueDouble申报价值,包裹类必填,货币单位根据currency确定,人民币单位是元
unitOfMeasurementstringSI:千克和厘米组合;SU:磅和英寸组合,默认是SI
tradeTermstring贸易条款;CFR,DAP等,国际贸易规范用于,默认DAP
currencystring货币单位,CNY-人民币;USD-美元;默认CNY
packageInfosArray[Object]包裹信息集合
exportInfosArray[Object]出口信息集合,一般包裹类要求必填,文件类不用填,用于清关报备
dutiesPaymentTypeObject关税支付方式,默认收件人支付
freightPaymentTypeObject运费支付方式
customsClearanceObject清关信息
invoiceInfoObject发票信息
routeIdString路线ID(极兔国际必填)
weightDouble重量
packageInfos数据格式
heightDouble高度;单位厘米,默认1.0
widthDouble宽度;单位厘米, 默认10.0
lengthDouble长度;单位厘米默认10.0
weightDouble重量; 单位千克,默认0.1
packageReferencestring该包裹的备注信息之类
exportInfos数据格式
netWeightDouble净重,单位kg,默认0.1
grossWeightDouble毛重,单位kg,默认 0.1
manufacturingCountryCodestring生产国代号;CN-中国,US-美国
unitPriceDouble物品单价,货币单位根据currency确定,人民币单位是元
quantityDouble物品数量,默认1.0
quantityUnitOfMeasurementstring计数单位,必填;PCS-件,KG-千克等,默认PCS
descstring物品描述
exportCommodityCodeString出口商品码,建议填写,加快清关速度
importCommodityCodeString进口商品码,建议填写,加快清关速度
dutiesPaymentType数据格式
paymentTypestring支付方式:DDU-寄方支付;DDP-收方支付;默认DDP
accountstring账号
freightPaymentType数据格式
paymentTypestring支付方式:SHIPPER-寄方付;CONSIGNEE-收方付 默认SHIPPER
accountstring账号
customsClearance数据格式
purposeString出口目的
isDocumentboolean是否是文件,默认true,是文件
invoiceInfo数据格式
dateString发票日期(格式:yyyy-MM-dd)`
numberString发票号
typeString发票类型,默认是商业发票,默认商业类型发票
titleString发票抬头,base64字符或常规字符,不同快递公司要求不一样
signatureString发票签名(BASE64字符串)
pltEnableboolean是否启用无纸化贸易(部分快递公司支持),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": "601470543"
	},
	"freightPaymentType": {
		"paymentType": "SHIPPER",
		"account": "601470543"
	},
	"customsClearance": {
		"purpose": "",
		"isDocument": true
	}
}


1.4 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
statusstring返回编码
messagestring返回报文描述
dataArray[Object]返回数据面单的相关信息

data数据结构

字段是否相应类型说明
kuaidinumYstring快递单号
pkgNumsOstring包裹号,多个包裹号用英文逗号分隔
invoiceOObject发票对象信息
contentYstring发票文件的base64字符
typeYstring文件格式
urlYstring文件短链接(有限期一个月)
labelYObject面单信息对象
typeYstring文件格式
urlYstring文件短链接(有限期一个月)

1.5 返回结果示例

{
    "taskId": "B92D370D43E8FCC3D18F765E6135BC69",
    "message": "成功",
    "result": true,
    "status": "200",
    "data": [
        {
            "pkgNums": "JD014600009041172054",
            "kuaidinum": "5824672696",
            "invoice": {
                "content": "base64Str",
                "type": "PDF",
                "url": "http://ckd.im/xxx"
            },
            "pdf": "base64Str",
            "label": {
                "content": "base64Str",
                "type": "pdf",
                "url": "http://ckd.im/xxx"
            }
        }
    ]
}


1.6 返回结果示例

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误

1.7 支持快递公司列表

快递公司编码
DHLdhl
Fedexfedex
极兔国际jet

1.8 国家代号字典表

下表仅供参考,具体支持邮寄的国家以快递公司的业务范围为准

国际名称国家代号
中国CN
印度尼西亚ID
葡萄牙PT
丹麦DK
卢森堡LU
克罗地亚HR
乌克兰UA
匈牙利HU
美国US
乌拉圭UY
印度IN
墨西哥MX
意大利IT
马来西亚MY
西班牙ES
阿根廷AR
巴西BR
智利CL
哥伦比亚CO
秘鲁PE