文档中心 > API类目 > 菜鸟集货API

cainiao.global.im.pickup.appointment.order.status (预约单状态查询)

预约单状态查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
appointment_order_status_request AppointmentOrderStatusRequest 必须 请求对象
  • └ seller_id
  • Number
  • 必须
  • 1697680011
  • 商家id
  • └ appointment_order_id
  • Number
  • 必须
  • 12344
  • 预约单id

响应参数

名称 类型 示例值 描述
hsf_result HsfResult hsfResult
  • appointment_order_status_response
  • AppointmentOrderStatusResponse
  • 响应体
  • └ id
  • Number
  • 1
  • 主键id
  • └ seller_id
  • Number
  • 1697680011
  • 商家id
  • └ code
  • String
  • RS2021122915053005
  • 预约单code
  • └ status_code
  • String
  • arrived
  • 状态code
  • └ status_name
  • String
  • gloalRegister.pms.enums.HandoverOrderStatusEnum.Arrived
  • 状态名称
  • └ gmt_modified
  • Date
  • 1640846967160
  • 更新时间
  • └ success
  • Boolean
  • true
  • 是否响应正常
  • └ error_code
  • String
  • xxxxx
  • 异常code
  • └ internal_error_code
  • String
  • xxxxx
  • 网络异常code
  • └ error_msg
  • String
  • xxxxx
  • 异常消息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGlobalImPickupAppointmentOrderStatusRequest req = new CainiaoGlobalImPickupAppointmentOrderStatusRequest();
CainiaoGlobalImPickupAppointmentOrderStatusRequest.AppointmentOrderStatusRequest obj1 = new CainiaoGlobalImPickupAppointmentOrderStatusRequest.AppointmentOrderStatusRequest();
obj1.setSellerId(1697680011L);
obj1.setAppointmentOrderId(12344L);
req.setAppointmentOrderStatusRequest(obj1);
CainiaoGlobalImPickupAppointmentOrderStatusResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_global_im_pickup_appointment_order_status_response>
    <hsf_result>
        <appointment_order_status_response>
            <id>1</id>
            <seller_id>1697680011</seller_id>
            <code>RS2021122915053005</code>
            <status_code>arrived</status_code>
            <status_name>gloalRegister.pms.enums.HandoverOrderStatusEnum.Arrived</status_name>
            <gmt_modified>1640846967160</gmt_modified>
        </appointment_order_status_response>
        <success>true</success>
        <error_code>xxxxx</error_code>
        <internal_error_code>xxxxx</internal_error_code>
        <error_msg>xxxxx</error_msg>
    </hsf_result>
</cainiao_global_im_pickup_appointment_order_status_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

返回
顶部