qimen.alibaba.idle.logistics.order.pre.create (快递预下单接口)

快递可上门的可达接口查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
goodsInfo IdleGoodsInfo 可选 物品信息
  • └ name
  • String
  • 可选
  • 手机
  • 名称
  • └ weight
  • String
  • 可选
  • 1000
  • 重量(单位g)
senderAddress IdleAddressSimpleInfo 必须 寄件人地址
  • └ name
  • String
  • 必须
  • 测试名称
  • 名称
  • └ mobile
  • String
  • 必须
  • 15600172826
  • 手机号码
  • └ province
  • String
  • 必须
  • 浙江省
  • └ city
  • String
  • 必须
  • 杭州
  • └ area
  • String
  • 必须
  • 余杭
  • └ town
  • String
  • 可选
  • 黄湖镇
  • └ addressDetail
  • String
  • 必须
  • 阿里巴巴西溪A区2号楼
  • 详细地址
receiverAddress IdleAddressSimpleInfo 必须 收件人地址
  • └ city
  • String
  • 必须
  • 杭州
  • └ area
  • String
  • 必须
  • 余杭
  • └ town
  • String
  • 可选
  • 黄湖镇
  • └ addressDetail
  • String
  • 必须
  • 阿里巴巴西溪A区2号楼
  • 详细地址
  • └ province
  • String
  • 必须
  • 浙江省
  • └ mobile
  • String
  • 必须
  • 15600172826
  • 手机
  • └ name
  • String
  • 必须
  • 测试名称
  • 名称
expectedGotStartTime String 可选 2022-10-10 10:00:00 预约上门开始时间预约
expectedGotEndTime String 可选 2022-10-12 10:00:00 预约上门结束时间
productCode String 必须 TY 产品编码
cpCode String 必须 YT 合作伙伴的编码
monthlyCard String 可选 7551234567 月结卡号

响应参数

名称 类型 示例值 描述
result Result 结果
  • data
  • IdleData
  • 业务数据
  • └ accessible
  • Boolean
  • true
  • 是否可达
  • accessibleTimes
  • AccessibleTime []
  • 23912319
  • 可达的日期
  • └ accessibleStartTime
  • String
  • 2022-10-10 10:00:00
  • 可达的结束时间 (2023:11:10 12:00:00)
  • └ accessibleTime
  • String
  • 2022-10-10
  • 可达的日期(2023:11:10 00:00:00)
  • └ accessibleEndTime
  • String
  • 2022-10-12 10:00:00
  • 可达的开始时间 (2023:11:10 10:00:00)
  • └ errorMsg
  • String
  • 业务数据
  • 错误信息
  • └ errorCode
  • String
  • SYS_ERR
  • 错误码
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ isRetry
  • Boolean
  • true
  • 是否重试

请求示例

{"receiverAddress":{"area":"余杭","addressDetail":"阿里巴巴西溪A区2号楼","town":"黄湖镇","province":"浙江省","city":"杭州","mobile":"15600172826","name":"测试名称"},"cpCode":"YT","senderAddress":{"area":"余杭","addressDetail":"阿里巴巴西溪A区2号楼","province":"浙江省","town":"黄湖镇","city":"杭州","name":"测试名称","mobile":"15600172826"},"productCode":"TY","monthlyCard":"7551234567","expectedGotStartTime":"2022-10-10 10:00:00","expectedGotEndTime":"2022-10-12 10:00:00","goodsInfo":{"name":"手机","weight":"1000"}}

响应示例

{
    "result":{
        "data":{
            "accessible":true,
            "accessibleTimes":[
                {
                        "accessibleStartTime":"2022-10-10 10:00:00",
                        "accessibleTime":"2022-10-10",
                        "accessibleEndTime":"2022-10-12 10:00:00"
                }
            ]
        },
        "errorMsg":"业务数据",
        "errorCode":"SYS_ERR",
        "success":true,
        "isRetry":true
    }
}

验签示例

{"result":{"errorCode":"sign-check-failure","errorMsg":"Illegal request"},"success":"false"}

错误码解释

错误码 错误描述 解决方案
isp.http-read-timeout

API工具

FAQ

返回
顶部