预约取件API
POST
http://api.kuaidi100.com/sendAssistant/order/pickUp
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| 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 | 电话 |
| 否 | 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 | 电话 |
| 否 | string | 邮箱 | |
| packageInfos | 是 | Array[Object] | 包裹信息集合 |
| packageInfos数据格式 | |||
| height | 否 | Double | 高度;单位厘米,默认1.0 |
| width | 否 | Double | 宽度;单位厘米, 默认10.0 |
| length | 否 | Double | 长度;单位厘米默认10.0 |
| weight | 否 | Double | 重量; 单位千克,默认0.1 |
2.6 返回信息代码含义
| 信息代码 | 信息内容描述 | 原因及建议处理方式 |
|---|---|---|
| 200 | 提交成功 | 提交成功 |
| 500 | 服务器错误 | 快递100的服务器出现间歇或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数写错等，也会报此错误 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://api.kuaidi100.com/sendAssistant/order/pickUp' \
--data-urlencode 'key=' \
--data-urlencode 'sign=' \
--data-urlencode 't=' \
--data-urlencode 'param='响应示例响应示例
{
"code": 200,
"data": {
"pickupConfirmationNumber": "CBJ180121002626",
"location": "CN"
},
"message": "success",
"time": 0,
"success": true
}请求参数
Body 参数application/x-www-form-urlencoded
key
string
必需
sign
string
必需
t
string
必需
param
string
由其他字段拼接
返回响应
扫码加入交流群