一、国际电子面单下单API

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

1.1 接口格式

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

1.2 请求地址

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

请求参数（header）

请求参数（body）

param数据结构：

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 返回结果

data数据结构

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

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 返回信息代码含义

1.7 支持快递公司列表

二、预约取件API

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

2.1 接口格式

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

2.2 请求地址

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

请求参数（header）

请求参数（body）

param数据结构：

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 返回结果

data数据结构

2.5 返回结果示例

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

2.6 返回信息代码含义

三、取消预约PI

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

3.1 接口格式

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

3.2 请求地址

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

请求参数（header）

请求参数（body）

param数据结构：

3.3 请求参数示例

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

3.4 返回结果

data数据结构

3.5 请求结果示例

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

3.6 返回信息代码含义