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

cainiao.global.im.pickup.appointment.order.cancel (首公里揽收-取消预约单)

首公里揽收-取消预约单创建

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
appointment_order_cancel_requset AppointmentOrderCancelRequset 必须 预约单取消请求参数
  • └ seller_id
  • Number
  • 必须
  • 3
  • 商家id
  • └ appointment_order_id
  • Number
  • 必须
  • 1231234
  • 预约单id

响应参数

名称 类型 示例值 描述
hsf_result HsfResult 响应体
  • appointment_cancle_reponse
  • AppointmentCancleReponse
  • 响应业务对象
  • └ result
  • Boolean
  • false
  • 取消是否成功
  • └ success
  • Boolean
  • false
  • 响应是否成功
  • └ error_code
  • String
  • xxxxx
  • 异常码
  • └ internal_error_code
  • String
  • xxxxx
  • 网略异常码
  • └ error_msg
  • String
  • xxxxx
  • 异常提示

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGlobalImPickupAppointmentOrderCancelRequest req = new CainiaoGlobalImPickupAppointmentOrderCancelRequest();
CainiaoGlobalImPickupAppointmentOrderCancelRequest.AppointmentOrderCancelRequset obj1 = new CainiaoGlobalImPickupAppointmentOrderCancelRequest.AppointmentOrderCancelRequset();
obj1.setSellerId(3L);
obj1.setAppointmentOrderId(1231234L);
req.setAppointmentOrderCancelRequset(obj1);
CainiaoGlobalImPickupAppointmentOrderCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_global_im_pickup_appointment_order_cancel_response>
    <hsf_result>
        <appointment_cancle_reponse>
            <result>false</result>
        </appointment_cancle_reponse>
        <success>false</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_cancel_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

返回
顶部