可上门时间切片接口

基本信息

接口名称
请求方式 post application/x-www-form-urlencoded
功能描述 商家请求edi获取可上门揽收时间切片
编码 UTF-8

入参

项目 名称 类型 必填 描述
对接码 logistic_provider_id String 是 菜鸟侧提供
签名 data_digest String 是 Base64(Md5(logistics_interface+双方约定的secretKey)),0.2 签名方法
业务报文 logistics_interface String 是 JSON
logistics_interface内容
项目 名称 类型 必填 描述
收货方信息 receiver Receiver 是 收货方信息，具体参见公共组件部分
发货方信息 sender Sender 是 发货方信息，具体参见公共组件部分
期望上门时间类型 expectCollectTimeType String 否 TWO_HOUR-两小时揽,TODAY-当日揽

出参

项目 名称 类型 必填
成功标识 success boolean 是
错误码 errorCode String 否
错误说明 errorMsg String 否
时间分片信息 data CollectTimeQueryResult 否

CollectTimeQueryResult内容

项目 名称 类型 必填 描述
是否可选 canSelect Boolean 否
错误码 errorCode String 否
失败原因 notSelectReason String 否
上门时间类型 collectTimeType String 否 TWO_HOUR-两小时揽,TODAY-当日揽
截止时间 cutOffTime String 否 格式如："19:00"
任务开始时间 startCollectTime String 否 格式如："09:00"
任务结束时间 lastCollectTime String 否 格式如："21:00"
任务时间列表 collectTimeDTOList List<CollectTimeDTO> 否
扩展字段 featureMap Map 否

CollectTimeDTO内容

项目 名称 类型 必填 描述
是否可选 canSelect Boolean 否
错误码 errorCode String 否
失败原因 notSelectReason String 否
时间 date String 否 格式如："2025-04-09"。
切片时间列表 selectTimeDTOList List<SelectTimeDTO> 否

SelectTimeDTO内容

项目 名称 类型 必填 描述
查询开始时间 selectStartTime String 否 格式如："09:00"。
查询结束时间 selectEndTime String 否 格式如："11:00"。

注意:

该接口必填参数：
字段 类型 描述
receiver->receiverName String(40) 收件人姓名
receiver->receiverMobile String(20) 收件人手机 不能有"-"以外的特殊字符
receiver->receiverProvince String(20) 收件人省份
receiver->receiverCity String(20) 收件人城市
receiver->receiverArea String(20) 收件人区县
receiver->receiverAddress String(256) 收件人详细地址
sender->senderName String(40) 寄件人姓名
sender->senderMobile String(20) 寄件人手机
sender->senderProvince String(20) 寄件人省份
sender->senderCity String(20) 寄件人城市
sender->senderArea String(20) 寄件人区县
sender->senderDid String(64) 寄件人地址id
sender->senderAddress String(256) 寄件人详细地址

url：

http://edi-daily.xpm.cainiao.com/ext/gateway/ediStandardPickupTime/api

请求： 仅供参考，实际测试账号需联系菜鸟速递开发提供

logistic_provider_id: edi_test_json

data_digest: Mq0TSL0kq6YZxgzJyOLxeQ==

logistics_interface:

{"receiver": {"receiverName": "张三","receiverMobile": "13812345678","receiverProvince": "广东省","receiverCity": "广州市","receiverArea": "天河区","receiverAddress": "广东省广州市天河区天河路123号"},"sender": {"senderName": "李四","senderMobile": "13998765432","senderProvince": "北京市","senderCity": "北京市","senderArea": "朝阳区","senderDid": "123456","senderAddress": "北京市北京市朝阳区朝阳北路456号"}}

两小时揽返回示例：

{"success":true,"data":{"canSelect":true,"collectTimeType":"TWO_HOUR","cutOffTime":"19:00","startCollectTime":"09:00","lastCollectTime":"21:00","collectTimeDTOList":[{"canSelect":true,"date":"2025-04-09","selectTimeDTOList":[{"selectStartTime":"09:00","selectEndTime":"11:00"},{"selectStartTime":"11:00","selectEndTime":"13:00"},{"selectStartTime":"13:00","selectEndTime":"15:00"},{"selectStartTime":"15:00","selectEndTime":"17:00"},{"selectStartTime":"17:00","selectEndTime":"19:00"},{"selectStartTime":"19:00","selectEndTime":"21:00"}]},{"canSelect":true,"date":"2025-04-10","selectTimeDTOList":[{"selectStartTime":"09:00","selectEndTime":"11:00"},{"selectStartTime":"11:00","selectEndTime":"13:00"},{"selectStartTime":"13:00","selectEndTime":"15:00"},{"selectStartTime":"15:00","selectEndTime":"17:00"},{"selectStartTime":"17:00","selectEndTime":"19:00"},{"selectStartTime":"19:00","selectEndTime":"21:00"}]},{"canSelect":true,"date":"2025-04-11","selectTimeDTOList":[{"selectStartTime":"09:00","selectEndTime":"11:00"},{"selectStartTime":"11:00","selectEndTime":"13:00"},{"selectStartTime":"13:00","selectEndTime":"15:00"},{"selectStartTime":"15:00","selectEndTime":"17:00"},{"selectStartTime":"17:00","selectEndTime":"19:00"},{"selectStartTime":"19:00","selectEndTime":"21:00"}]}]}}

当日揽返回示例：

{"data":{"canSelect":true,"collectTimeDTOList":[{"canSelect":true,"date":"2025-04-09"},{"canSelect":true,"date":"2025-04-10"},{"canSelect":true,"date":"2025-04-11"}],"collectTimeType":"TODAY","cutOffTime":"17:00","lastCollectTime":"19:00","startCollectTime":"09:00"},"success":true}