文档中心 > API类目 > 驿马前台api

cainiao.yima.locker.appoitment.query (查询小件员预约单详情)

查询小件员预约单详情

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
appointment_id Number 必须 12312 预约单id
user_id Number 必须 1232 小件员id

响应参数

名称 类型 示例值 描述
status_message String 成功 errorDesc
status_code String 200 errorCode
is_success Boolean success success
data CourierAppointmentOrderDto 10 约柜预约单状态:0-创建,10-预约成功,100-正常结束,-1-取消, -10-预约失败。
  • appointment_cells
  • AppointmentCellsInfo
  • appointment_cells
  • 实际预约柜口及数量列表
  • └ micro
  • Number
  • 1
  • 微格数量
  • └ small
  • Number
  • 1
  • 小格数量
  • └ middle
  • Number
  • 1
  • 中格数量
  • └ large
  • Number
  • 1
  • 大格数量
  • └ huge
  • Number
  • 1
  • 超大格数量
  • └ total
  • Number
  • 5
  • 总数
  • └ status
  • Number
  • 100
  • 约柜订单状态:0-创建,10-预约成功,100-正常结束,-1-取消, -10-预约失败。
  • └ station_id
  • Number
  • 432964
  • 柜子stationid
  • └ id
  • Number
  • 1
  • 预约单id
  • └ gui_addr
  • String
  • 菜鸟总部(乐佳国际大厦)1号楼南面
  • 柜子地址
  • └ gui_brand
  • String
  • 速递易翠苑一区
  • 柜子品牌
  • └ aoi_name
  • String
  • 翠苑一区
  • aoi小区名
  • └ company_name
  • String
  • 速递易
  • 柜子公司名字
  • └ appointment_start_mills
  • Number
  • 12121
  • 起约时间,单位毫秒
  • └ appointment_request_time_mills
  • Number
  • 1232131
  • 预约请求时间,单位毫秒
  • └ appointment_release_time_mills
  • Number
  • 12321321312
  • 预约失效剩余时长,单位毫秒
  • └ pay_timeout_mills
  • Number
  • 1232
  • 支付超时剩余时长,单位毫秒

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaLockerAppoitmentQueryRequest req = new CainiaoYimaLockerAppoitmentQueryRequest();
req.setAppointmentId(12312L);
req.setUserId(1232L);
CainiaoYimaLockerAppoitmentQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_locker_appoitment_query_response>
    <status_message>成功</status_message>
    <status_code>200</status_code>
    <is_success>success</is_success>
    <data>
        <appointment_cells>
            <micro>1</micro>
            <small>1</small>
            <middle>1</middle>
            <large>1</large>
            <huge>1</huge>
            <total>5</total>
        </appointment_cells>
        <status>100</status>
        <station_id>432964</station_id>
        <id>1</id>
        <gui_addr>菜鸟总部(乐佳国际大厦)1号楼南面</gui_addr>
        <gui_brand>速递易翠苑一区</gui_brand>
        <aoi_name>翠苑一区</aoi_name>
        <company_name>速递易</company_name>
        <appointment_start_mills>12121</appointment_start_mills>
        <appointment_request_time_mills>1232131</appointment_request_time_mills>
        <appointment_release_time_mills>12321321312</appointment_release_time_mills>
        <pay_timeout_mills>1232</pay_timeout_mills>
    </data>
</cainiao_yima_locker_appoitment_query_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部