快递100 API

预约取件API

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

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

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

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

请求参数

Body 参数application/x-www-form-urlencoded

key

string

必需

授权码，请到快递100页面申请企业版接口获取

sign

string

必需

32位大写签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号，secret可在企业管理后台中企业信息查看

string

必需

时间戳如：1576123932000

param

string

由其他字段拼接

必需

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

code

integer

返回编码

必需

data

object

返回数据

必需

预约取件单号

pickupConfirmationNumber

string

预约取件单号

必需

location

string

预约取件地址

必需

message

string

返回报文描述

必需

time

integer

返回时间

必需

success

boolean

是否成功

必需

true成功，false失败

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

最后修改时间： 2 年前