文档中心
一、国际电子面单下单API 二、预约取件API 三、取消预约API API调试工具

一、国际电子面单下单API

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

1.1 接口格式

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

1.2 请求地址

http://api.kuaidi100.com/sendAssistant/order/apiCall

请求参数（header）

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

请求参数（body）

参数名是否必填类型说明
key是string授权码，请到快递100页面申请企业版接口获取
sign是string32位大写签名，用于验证身份，按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电话
└email否string邮箱
└taxId否string税号
└taxType否string纳税人类型
└vatNum否stringVAT税号(数字或字母)；欧盟国家(含英国)使用的增值税号；
└eoriNum否stringEORI号码(数字或字母)；欧盟入关时需要EORI号码，用于商品货物的清关
└iossNum否stringIOSS号码
Θ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电话
└email否string邮箱
└taxId否string税号
└taxType否string纳税人类型
└vatNum否stringVAT税号(数字或字母)；欧盟国家(含英国)使用的增值税号；
└eoriNum否stringEORI号码(数字或字母)；欧盟入关时需要EORI号码，用于商品货物的清关
└iossNum否stringIOSS号码
cargo否string货物描述
count否string包裹总数量，设置数量大于1时，是指同一个订单打印出多张电子面单，即同一个订单返回多个面单号，此时需要按照设置的数量N对应提供N个包裹信息（packageInfos）
weight否string物品总重量
expType否string产品类型： 默认标准快递，请参考参数字典）
remark否string备注
customsValue否Double申报价值,包裹类必填,货币单位根据currency确定,人民币单位是元
unitOfMeasurement否stringSI:千克和厘米组合；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.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": [{

		"zhName ": "",
		"enName ": "",
		"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 返回结果

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

data数据结构

字段类型说明
kuaidicomstring快递公司
kuaidinumstring快递单号
pkgNumsstring包裹号,多个包裹号用英文逗号分隔
ΘinvoiceObject发票对象信息
└contentstring发票文件的base64字符
└fileNamestring文件名
└typestring文件格式
└urlstring文件短链接(有限期一个月)
invoicesArray[invoice]多个发票信息集合，数据结构同invoice。fedex单包裹和多包裹都会返回，单个包裹情况返回结果一样，多个包裹情况invoices返回多个发票信息，invoice返回第一个发票信息
ΘlabelObject面单信息对象
└contentstring面单文件的base64字符
└fileNamestring文件名
└typestring文件格式
└urlstring文件短链接(有限期一个月)
labelsArray[label]多个面单信息集合，数据结构同label。fedex单包裹和多包裹都会返回，单个包裹情况返回结果一样，多个包裹情况labels返回多个面单信息，label返回第一个面单信息

注意：实际返回的字段各家快递公司不同，以实际返回为准

1.5 返回结果示例

{
	"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
	}]
}

1.6 返回信息代码含义

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

1.7 支持快递公司列表

快递公司编码
DHLdhl
Fedexfedex
UPSUPS
极兔国际jet
邮政国际chinapost
百世国际baishiguoji
递四方disifang

二、预约取件API

通过接口预约快递员上门取件，支持Fedex、DHL两家国际快递公司。

2.1 接口格式

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

2.2 请求地址

http://api.kuaidi100.com/sendAssistant/order/pickUp

请求参数（header）

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

请求参数（body）

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

param数据结构：

参数名是否必填类型说明
partnerId是string月结或支付账号，详见字典表
partnerName是string月结账号用户名，详见字典表
partnerKey否string月结账号密钥，详见字典表（DHL可以不传）
partnerSecret是string月结账号用户密码，详见字典表
code否string账号参数，详见字典表（DHL可以不传）
kuaidicom是string快递公司的编码，一律用小写字母，见参数字典）
pickupTimestamp是string预约取件时间，时间格式为2022-05-13 15:00:00。不能是过去时间，Fedex只能是当天或者第二天时间，DHL只能是未来28天内时间。
pickupLocationCloseTime是string最晚取件时间，24小时制，格式为17:00
instruction是string给快递员的指令内容
remarks否string预约取件备注
ΘrecMan是recMan收件人信息
￢name是string收件人姓名
￢mobile是string收件人的手机号，手机号和电话号二者其一必填
￢addr是string收件人所在完整地址
￢district否string郡|县,可作为收件地址补充
￢province否string州|省,可作为收件地址补充
￢company否string公司名称
￢countryCode是string国家代号 CN-中国 ,US-美国等, 详见字典表
￢city是string城市
￢zipcode是string邮编
￢tel否string电话
￢email否string邮箱
ΘsendMan是sendMan寄件人信息
￢name是string寄件人姓名
￢mobile是string寄件人的手机号
￢addr是string寄件人所在的完整地址
￢district否string郡|县,可作为收件地址补充
￢province否string州|省,可作为收件地址补充
￢company否string公司名称
￢countryCode是string国家代号 CN-中国 ,US-美国等, 详见字典表
￢city是string城市
￢zipcode是string邮编
￢tel否string电话
￢email否string邮箱
packageInfos是Array[Object]包裹信息集合
packageInfos数据格式
height否Double高度;单位厘米,默认1.0
width否Double宽度;单位厘米, 默认10.0
length否Double长度;单位厘米默认10.0
weight否Double重量; 单位千克,默认0.1

2.3 请求参数示例

{
	"key": "*******",
	"sign": "********",
	"t": "1652320276",
	"param": {
		"pickupTimestamp": "2022-05-16 08:41:35",
		"pickupLocationCloseTime": "17:00",
		"instruction": "Collect at reception",
		"partnerId": "******",
		"partnerName": "******",
		"partnerSecret": "******",
		"kuaidicom": "dhl",
		"sendMan": {
			"name": "Kaka",
			"mobile": "13500000000",
			"addr": "Kingdee Software Park",
			"countryCode": "CN",
			"city": "SHEN ZHEN",
			"zipcode": "518057"
		},
		"recMan": {
			"name": "Cindy Martinez / Ana Luz Medina",
			"mobile": "(86)13510002000",
			"addr": "Apoquindo 4001, of. 501. Las Condes",
			"countryCode": "CL",
			"city": "Santiago",
			"zipcode": "7550000"
		},
		"packageInfos": [{
				"height": "10",
				"width": "20",
				"length": "11",
				"weight": "0.1"
			},
			{
				"height": "10",
				"width": "20",
				"length": "11",
				"weight": "0.1"
			},
			{
				"height": "10",
				"width": "20",
				"length": "11",
				"weight": "0.1"
			}
		]
	}
}

2.4 返回结果

字段类型说明备注
codeInteger返回编码
messagestring返回报文描述
timeLong返回时间
successBoolean是否成功true成功，false失败
dataArray[Object]返回数据预约取件单号

data数据结构

字段类型说明
pickupConfirmationNumbestring预约取件单号
locationestring预约取件地址

2.5 返回结果示例

{
	"code": 200,
	"data": {
		"pickupConfirmationNumber": "CBJ180121002626",
		“location”: ”CN”
	},
	"message": "success",
	"time": 0,
	"success": true
}

2.6 返回信息代码含义

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

三、取消预约PI

通过接口取消已下达的上门取件请求，支持Fedex、DHL两家国际快递公司。

3.1 接口格式

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

3.2 请求地址

http://api.kuaidi100.com/sendAssistant/order/pickUp

请求参数（header）

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

请求参数（body）

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

param数据结构：

参数名是否必填类型说明
partnerId是string月结或支付账号，详见字典表
partnerName是string月结账号用户名，详见字典表
partnerKey否string月结账号密钥，详见字典表（DHL可以不传）
partnerSecret是string月结账号用户密码，详见字典表
code否string账号参数，详见字典表（DHL可以不传）
kuaidicom是string快递公司的编码，一律用小写字母，见参数字典）
pickUpDate是string预约取件日期，，格式为YYYY-MM-DD。例如：2022-06-10
location是string预约取件地点，fedex用预约取件接口返回的location值,dhl用预约取件传入的发件人countryCode
pickupConfirmationNumber是string预约取件单号

3.3 请求参数示例

{
	"pickUpDate": "2022-05-31",
	"location": "CN",
	"partnerId": " xxx ",
	"partnerName": "xxx",
	"partnerSecret": " xxx ",
	"partnerKey": " xxx ",
	"code": " xxx ",
	"kuaidicom": "dhl",
	"pickupConfirmationNumber": "CBJ220608002901"
}

3.4 返回结果

字段类型说明备注
codeInteger返回编码
messagestring返回报文描述
timeLong返回时间
successBoolean是否成功true成功，false失败
dataObject返回数据取消预约结果

data数据结构

字段类型说明
resultstring是否成功，true成功，false失败
messagstring返回报文描述

3.5 请求结果示例

{
	"code": 200,
	"data": {
		"result": true,
		“message”: ”success”
	},
	"message": "success",
	"time": 0,
	"success": true

3.6 返回信息代码含义

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

一对一咨询

  • 电话图标

    电话咨询

    0755-86719032

    专业客服团队为您服务

  • 二维码图标

    联系商务

    二维码

    扫码添加工作人员

  • 小程序图标

    小程序

    小程序

    扫码进入企业助手