文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.fulfil.taskdetail (快递员任务单详情getTaskDetailInfo)

任务详情getTaskDetailInfo

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
app_context_param AppContextParam 必须 客户端信息
  • └ app_battery
  • String
  • 可选
  • 45
  • 电池用电量
  • └ device_type
  • String
  • 可选
  • ios
  • app是android还是ios
  • └ loc_accuracy
  • String
  • 可选
  • 23
  • 小件员-定位时间
  • └ loc_auth
  • String
  • 可选
  • true
  • gps-定位权限授予
  • └ loc_lat
  • String
  • 可选
  • 123.22
  • 小件员-所在的纬度
  • └ loc_lng
  • String
  • 可选
  • 123.22
  • 小件员-所在的经度
  • └ loc_open
  • String
  • 可选
  • true
  • gps-定位是否打开,GPS定位开启
  • └ loc_succ
  • String
  • 可选
  • true
  • gps-定位是否成功
  • └ loc_time
  • Number
  • 可选
  • 123
  • 小件员-定位时间
  • └ loc_type
  • String
  • 可选
  • gps
  • 小件员-定位方式
  • └ pkg_id
  • String
  • 可选
  • fsdfId
  • 对应包裹侠的包id
  • └ pkg_name
  • String
  • 可选
  • fsdf.sdf
  • 对应包裹侠的包名
  • └ sdk_version
  • String
  • 可选
  • 6.0.1
  • sdk的版本号
execute_user_list ExecuteUserDto [] 必须
  • 最大列表长度:20
  • 账号list
    • └ execute_user_id
    • Number
    • 可选
    • 0
    • 参数executeUserId
    • └ execute_user_type
    • String
    • 可选
    • foo
    • 参数executeUserType
    personal_session String 必须 dsdf324234234324 个人账号sessionCode不能为空
    personal_user_id Number 必须 324234234324 个人账号ID不能为空
    task_order_id Number 必须 1042423423 履行任务单ID不能为空

    响应参数

    名称 类型 示例值 描述
    data OperTaskDetailDto 参数data
    • flow_actions
    • FlowOperBtnVo []
    • 待执行的实操按钮
    • btn_prop_list
    • OperPropInfo []
    • 实操属性集合
    • └ key
    • String
    • packageType
    • 实操结果key
    • └ value
    • String
    • 日用品
    • 实操结果val
    • └ btn_text
    • String
    • true
    • 按钮上的文本
    • └ btn_type
    • String
    • true
    • 流程类型:主要,跳过
    • └ fulfil_node
    • String
    • TAKE_PACKAGE
    • 履行行为节点
    • └ fulfil_node_name
    • String
    • 等揽件
    • 履行行为节点描述
    • └ oper_code
    • String
    • courierArrive
    • 实操行为code
    • general_actions
    • GeneralOperBtnAndRetVo []
    • 已执行的行为结果
    • btn_prop_list
    • OperPropInfo []
    • 实操属性集合
    • └ key
    • String
    • packageType
    • 实操结果key
    • └ value
    • String
    • 日用品
    • 实操结果val
    • └ can_skip
    • Boolean
    • true
    • 能否跳过
    • └ enable
    • Boolean
    • true
    • 是否可以执行
    • └ expect_end_date
    • Number
    • 11232132
    • 预计结束时间
    • └ expect_start_date
    • Number
    • 11232132
    • 预计开始时间
    • └ oper_code
    • String
    • courierArrive
    • 实操行为code
    • └ oper_date
    • Number
    • 11232132
    • 实操行为时间
    • └ oper_status
    • Number
    • 20
    • 10未执行,20执行失败,30执行成功, 31第二次执行成功,40异常执行成功,100已跳过
    • ret_prop_list
    • OperPropInfo []
    • 实操属性集合
    • └ key
    • String
    • packageType
    • 实操结果key
    • └ value
    • String
    • 日用品
    • 实操结果val
    • └ flow_type
    • String
    • ex_oper
    • 流程类型:ex_oper异常行为,general_oper普通行为,flow_oper流程行为
    • └ btn_text
    • String
    • 取消
    • 按钮名称
    • oper_task_data
    • OperTaskData
    • 实操任务单详情
    • └ cancel_reason
    • String
    • 联系不到消费者
    • 取消原因
    • consumer_pay_info
    • TaskPayInfoFeeItem
    • 消费者支付金额信息
    • └ actual_coupon_price
    • String
    • 3.0
    • 优惠价格
    • └ actual_pay_price
    • String
    • 120.12
    • 用户实际支付的价格
    • └ goods_height
    • String
    • 11.1
    • 物品高度,单位:厘米
    • └ goods_length
    • String
    • 11.1
    • 物品长度,单位:厘米
    • └ goods_weight
    • String
    • 111
    • 物品重量,单位:克
    • └ goods_width
    • String
    • 11.1
    • 物品宽度,单位:厘米
    • part_list
    • MoneyUnitItem []
    • 费用构成
    • └ code
    • String
    • packageFee
    • 金额code
    • └ desc
    • String
    • 对公结算
    • 金额描述
    • └ name
    • String
    • 寄件基础价
    • 金额名称
    • └ unit
    • String
    • fen
    • 金额单位
    • └ value
    • String
    • 111.2
    • 金额值
    • └ total_price
    • String
    • 123.12
    • 订单总价
    • item_list
    • EntryItemVo []
    • 重量列表
    • └ item_key
    • String
    • 展示项键
    • └ value
    • String
    • 展示项值
    • └ code
    • String
    • 编码
    • courier_fee_info
    • TaskCourierBenefitItem
    • 快递员收支情况
    • part_list
    • MoneyUnitItem []
    • 费用构成
    • └ code
    • String
    • packageFee
    • 金额code
    • └ desc
    • String
    • 对公结算
    • 金额描述
    • └ name
    • String
    • 寄件基础价
    • 金额名称
    • └ unit
    • String
    • fen
    • 金额单位
    • └ value
    • String
    • 111.2
    • 金额值
    • └ show_reward
    • Boolean
    • true
    • 是否显示菜鸟补贴
    • └ total_income
    • String
    • 120.12
    • 总体收益
    • expect_time_list
    • OperExpectTimeDto []
    • 需要提醒的某些实操的时间,如揽件,回单
    • └ expect_end_date
    • Number
    • 11232132
    • 预计结束行为时间
    • └ expect_start_date
    • Number
    • 11232132
    • 预计开始行为时间
    • └ oper_code
    • String
    • courierArrive
    • 实操行为code
    • └ oper_date
    • Number
    • 111111111
    • 实际行为发生时间
    • └ fulfil_type
    • Number
    • 1
    • 履行方式 1驿站,2柜子,3上门
    • └ fulfil_type_desc
    • String
    • 寄件
    • 履行方式 1驿站,2柜子,3上门
    • package_info
    • PackageItem
    • 包裹信息
    • └ check_package_code
    • String
    • S-23123
    • 对货码,门店发货专用
    • └ cp_icon_url
    • String
    • icon...
    • 运单号所属CP的图标
    • └ mail_no
    • String
    • 234324324324
    • 运单号
    • └ mail_no_cp
    • String
    • TTKDEX
    • 运单号所属CP
    • └ mail_no_cp_name
    • String
    • 天天快递
    • 运单号所属CP名称
    • └ mail_no_type
    • String
    • 1
    • 1电子面单,2纸质面单
    • └ package_type
    • String
    • 日用品
    • 包裹类型
    • └ user_message_labels
    • String
    • 小心轻放
    • 用户备注
    • └ pkg_image_list
    • String []
    • pkgImageList
    • └ arrive_sign
    • String
    • 2dsfsdf
    • 我已到达标示
    • └ pay_state
    • Number
    • 1
    • 支付状态
    • └ pay_state_desc
    • String
    • 已支付
    • 支付状态描述
    • receiver
    • SimpleCustomInfo
    • 收件人信息
    • └ area_id
    • Number
    • 330110
    • 地区areaId
    • └ box_address
    • String
    • 阿里巴巴西溪园区2号楼速递易
    • 柜子地址
    • └ can_call
    • Boolean
    • true
    • 是否可以拨打电话
    • └ city_name
    • String
    • 杭州市
    • 市名称
    • └ district_name
    • String
    • 余杭区
    • 名称
    • └ latitude
    • String
    • 130.11
    • 纬度
    • └ loc_address
    • String
    • 中节能西溪首座
    • 详细地址(不带省市区)
    • └ longitude
    • String
    • 30.11
    • 经度
    • └ name
    • String
    • 张三
    • 姓名
    • └ phone
    • String
    • 13611112222
    • 电话号码
    • └ prov_name
    • String
    • 浙江省
    • 省名称
    • └ require_order_id
    • Number
    • 1042423499
    • 需求单ID不能为空
    • sender
    • SimpleCustomInfo
    • 寄件人信息
    • └ area_id
    • Number
    • 330110
    • 地区areaId
    • └ box_address
    • String
    • 阿里巴巴西溪园区2号楼速递易
    • 柜子地址
    • └ can_call
    • Boolean
    • true
    • 是否可以拨打电话
    • └ city_name
    • String
    • 杭州市
    • 市名称
    • └ district_name
    • String
    • 余杭区
    • 名称
    • └ latitude
    • String
    • 130.11
    • 纬度
    • └ loc_address
    • String
    • 中节能西溪首座
    • 详细地址(不带省市区)
    • └ longitude
    • String
    • 30.11
    • 经度
    • └ name
    • String
    • 张三
    • 姓名
    • └ phone
    • String
    • 13611112222
    • 电话号码
    • └ prov_name
    • String
    • 浙江省
    • 省名称
    • └ box_name
    • String
    • 菜鸟一号柜
    • 柜机名称
    • └ task_order_id
    • Number
    • 301231231232
    • 履行任务单id
    • └ task_spend_time
    • Number
    • 30
    • 本单耗时
    • └ task_status_code
    • Number
    • 30
    • 任务状态
    • └ task_status_desc
    • String
    • 已揽件
    • 任务状态描述
    • time_line_list
    • OperTimeLineVo []
    • 时间线
    • └ line_name
    • String
    • 抢单时间
    • 时间线name
    • └ oper_date
    • Number
    • 12312321321
    • 实操行为发生时间
    • └ trade_order_id
    • Number
    • 1042423499
    • 交易单ID
    • └ status_code
    • String
    • 1
    • 1待接单,2待取件,3待支付,4已取消,5待回单,6尚未支付,7已取件,8已寄出,9已拒收,10待验收,13客户取消,14快递员取消,15待妥投,17待核价,99已完成
    • branch_pay_info
    • BranchPayInfoDto
    • 网点代付信息
    • └ pay_flag
    • Number
    • 1
    • 1代表网点代付信息
    • └ pay_desc
    • String
    • 网点代付
    • “网点代付”文案
    • └ pay_reason_code
    • String
    • code
    • 网点代付原因code
    • └ pay_reason_desc
    • String
    • 原因描述
    • 网点代付原因描述
    • └ append_status_remark
    • String
    • 附加状态描述
    • 取消待确认
    • tag_infos
    • TagInfo []
    • 标签
    • └ type
    • String
    • exception
    • 类型
    • └ value
    • String
    • 无需寄件
    • └ tag
    • String
    • 异常单
    • 标签
    • └ seq_num
    • String
    • 2222
    • 线下票号(小黄筒#袋子码,小邮票邮票号)
    • title_tag_infos
    • TagInfo []
    • 标题
    • └ type
    • String
    • 11
    • 类型
    • └ value
    • String
    • 11
    • 类型值
    • └ tag
    • String
    • 11
    • 标签
    • pay_tip_info
    • PayTipInfo
    • 提示信息
    • └ prompt_info_url
    • String
    • qq
    • 链接
    • └ prompt_info
    • String
    • ss
    • 提示信息
    • └ calcuate_remind_info
    • String
    • title下方的提示描述
    • └ price_remind_info
    • String
    • title中钱的下方的描述
    • step_price_info
    • StepPriceInfo
    • 阶梯价信息
    • └ cp_quote_rank
    • String
    • 1
    • 阶梯等级
    • └ cp_quote_with_order_num
    • String
    • 2
    • 参与阶梯价计算的订单数
    • └ step_price_url
    • String
    • http
    • 阶梯价url
    • └ server_time
    • Number
    • 123124124
    • 服务器时间
    status_code String PARAMS_CANNOT_BE_NULL 错误码
    status_message String 参数不能为空 错误描述
    is_success Boolean true 是否成功
    trace_id String 0be4314615320739620257888e18e2 鹰眼ID

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoFulfilTaskdetailRequest req = new CainiaoGuoguoFulfilTaskdetailRequest();
    CainiaoGuoguoFulfilTaskdetailRequest.AppContextParam obj1 = new CainiaoGuoguoFulfilTaskdetailRequest.AppContextParam();
    obj1.setAppBattery("45");
    obj1.setDeviceType("ios");
    obj1.setLocAccuracy("23");
    obj1.setLocAuth("true");
    obj1.setLocLat("123.22");
    obj1.setLocLng("123.22");
    obj1.setLocOpen("true");
    obj1.setLocSucc("true");
    obj1.setLocTime(123L);
    obj1.setLocType("gps");
    obj1.setPkgId("fsdfId");
    obj1.setPkgName("fsdf.sdf");
    obj1.setSdkVersion("6.0.1");
    req.setAppContextParam(obj1);
    List<CainiaoGuoguoFulfilTaskdetailRequest.ExecuteUserDto> list3 = new ArrayList<CainiaoGuoguoFulfilTaskdetailRequest.ExecuteUserDto>();
    CainiaoGuoguoFulfilTaskdetailRequest.ExecuteUserDto obj4 = new CainiaoGuoguoFulfilTaskdetailRequest.ExecuteUserDto();
    list3.add(obj4);
    obj4.setExecuteUserId(0L);
    obj4.setExecuteUserType("foo");
    req.setExecuteUserList(list3);
    req.setPersonalSession("dsdf324234234324");
    req.setPersonalUserId(324234234324L);
    req.setTaskOrderId(1042423423L);
    CainiaoGuoguoFulfilTaskdetailResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_guoguo_fulfil_taskdetail_response>
        <data>
            <flow_actions>
                <flow_oper_btn_vo>
                    <btn_prop_list>
                        <oper_prop_info>
                            <key>packageType</key>
                            <value>日用品</value>
                        </oper_prop_info>
                    </btn_prop_list>
                    <btn_text>true</btn_text>
                    <btn_type>true</btn_type>
                    <fulfil_node>TAKE_PACKAGE</fulfil_node>
                    <fulfil_node_name>等揽件</fulfil_node_name>
                    <oper_code>courierArrive</oper_code>
                </flow_oper_btn_vo>
            </flow_actions>
            <general_actions>
                <general_oper_btn_and_ret_vo>
                    <btn_prop_list>
                        <oper_prop_info>
                            <key>packageType</key>
                            <value>日用品</value>
                        </oper_prop_info>
                    </btn_prop_list>
                    <can_skip>true</can_skip>
                    <enable>true</enable>
                    <expect_end_date>11232132</expect_end_date>
                    <expect_start_date>11232132</expect_start_date>
                    <oper_code>courierArrive</oper_code>
                    <oper_date>11232132</oper_date>
                    <oper_status>20</oper_status>
                    <ret_prop_list>
                        <oper_prop_info>
                            <key>packageType</key>
                            <value>日用品</value>
                        </oper_prop_info>
                    </ret_prop_list>
                    <flow_type>ex_oper</flow_type>
                    <btn_text>取消</btn_text>
                </general_oper_btn_and_ret_vo>
            </general_actions>
            <oper_task_data>
                <cancel_reason>联系不到消费者</cancel_reason>
                <consumer_pay_info>
                    <actual_coupon_price>3.0</actual_coupon_price>
                    <actual_pay_price>120.12</actual_pay_price>
                    <goods_height>11.1</goods_height>
                    <goods_length>11.1</goods_length>
                    <goods_weight>111</goods_weight>
                    <goods_width>11.1</goods_width>
                    <part_list>
                        <money_unit_item>
                            <code>packageFee</code>
                            <desc>对公结算</desc>
                            <name>寄件基础价</name>
                            <unit>fen</unit>
                            <value>111.2</value>
                        </money_unit_item>
                    </part_list>
                    <total_price>123.12</total_price>
                    <item_list>
                        <entry_item_vo>
                            <item_key></item_key>
                            <value></value>
                            <code></code>
                        </entry_item_vo>
                    </item_list>
                </consumer_pay_info>
                <courier_fee_info>
                    <part_list>
                        <money_unit_item>
                            <code>packageFee</code>
                            <desc>对公结算</desc>
                            <name>寄件基础价</name>
                            <unit>fen</unit>
                            <value>111.2</value>
                        </money_unit_item>
                    </part_list>
                    <show_reward>true</show_reward>
                    <total_income>120.12</total_income>
                </courier_fee_info>
                <expect_time_list>
                    <oper_expect_time_dto>
                        <expect_end_date>11232132</expect_end_date>
                        <expect_start_date>11232132</expect_start_date>
                        <oper_code>courierArrive</oper_code>
                        <oper_date>111111111</oper_date>
                    </oper_expect_time_dto>
                </expect_time_list>
                <fulfil_type>1</fulfil_type>
                <fulfil_type_desc>寄件</fulfil_type_desc>
                <package_info>
                    <check_package_code>S-23123</check_package_code>
                    <cp_icon_url>icon...</cp_icon_url>
                    <mail_no>234324324324</mail_no>
                    <mail_no_cp>TTKDEX</mail_no_cp>
                    <mail_no_cp_name>天天快递</mail_no_cp_name>
                    <mail_no_type>1</mail_no_type>
                    <package_type>日用品</package_type>
                    <user_message_labels>小心轻放</user_message_labels>
                    <pkg_image_list>
                        <string></string>
                    </pkg_image_list>
                    <arrive_sign>2dsfsdf</arrive_sign>
                </package_info>
                <pay_state>1</pay_state>
                <pay_state_desc>已支付</pay_state_desc>
                <receiver>
                    <area_id>330110</area_id>
                    <box_address>阿里巴巴西溪园区2号楼速递易</box_address>
                    <can_call>true</can_call>
                    <city_name>杭州市</city_name>
                    <district_name>余杭区</district_name>
                    <latitude>130.11</latitude>
                    <loc_address>中节能西溪首座</loc_address>
                    <longitude>30.11</longitude>
                    <name>张三</name>
                    <phone>13611112222</phone>
                    <prov_name>浙江省</prov_name>
                </receiver>
                <require_order_id>1042423499</require_order_id>
                <sender>
                    <area_id>330110</area_id>
                    <box_address>阿里巴巴西溪园区2号楼速递易</box_address>
                    <can_call>true</can_call>
                    <city_name>杭州市</city_name>
                    <district_name>余杭区</district_name>
                    <latitude>130.11</latitude>
                    <loc_address>中节能西溪首座</loc_address>
                    <longitude>30.11</longitude>
                    <name>张三</name>
                    <phone>13611112222</phone>
                    <prov_name>浙江省</prov_name>
                    <box_name>菜鸟一号柜</box_name>
                </sender>
                <task_order_id>301231231232</task_order_id>
                <task_spend_time>30</task_spend_time>
                <task_status_code>30</task_status_code>
                <task_status_desc>已揽件</task_status_desc>
                <time_line_list>
                    <oper_time_line_vo>
                        <line_name>抢单时间</line_name>
                        <oper_date>12312321321</oper_date>
                    </oper_time_line_vo>
                </time_line_list>
                <trade_order_id>1042423499</trade_order_id>
                <status_code>1</status_code>
                <branch_pay_info>
                    <pay_flag>1</pay_flag>
                    <pay_desc>网点代付</pay_desc>
                    <pay_reason_code>code</pay_reason_code>
                    <pay_reason_desc>原因描述</pay_reason_desc>
                </branch_pay_info>
                <append_status_remark>附加状态描述</append_status_remark>
                <tag_infos>
                    <tag_info>
                        <type>exception</type>
                        <value>无需寄件</value>
                        <tag>异常单</tag>
                    </tag_info>
                </tag_infos>
                <seq_num>2222</seq_num>
                <title_tag_infos>
                    <tag_info>
                        <type>11</type>
                        <value>11</value>
                        <tag>11</tag>
                    </tag_info>
                </title_tag_infos>
                <pay_tip_info>
                    <prompt_info_url>qq</prompt_info_url>
                    <prompt_info>ss</prompt_info>
                </pay_tip_info>
                <calcuate_remind_info></calcuate_remind_info>
                <price_remind_info></price_remind_info>
                <step_price_info>
                    <cp_quote_rank>1</cp_quote_rank>
                    <cp_quote_with_order_num>2</cp_quote_with_order_num>
                    <step_price_url>http</step_price_url>
                </step_price_info>
            </oper_task_data>
            <server_time>123124124</server_time>
        </data>
        <status_code>PARAMS_CANNOT_BE_NULL</status_code>
        <status_message>参数不能为空</status_message>
        <is_success>true</is_success>
        <trace_id>0be4314615320739620257888e18e2</trace_id>
    </cainiao_guoguo_fulfil_taskdetail_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

    返回
    顶部