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

cainiao.yima.dispatch.list.specified.get (获取指定的派单列表)

获取指定的派单列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id String 可选 2134 小件员内部ID
order_ids String 可选 243,243 逗号分隔,订单id

响应参数

名称 类型 示例值 描述
data DocDailyDispatchDto 0 结果
  • doc_dispatch_item_list
  • DocDailyDispatchItem []
  • list
  • 结果列表
  • └ can_send_message
  • Boolean
  • true
  • 是否仍可发送短信
  • └ cannot_notification_prompt
  • String
  • 不能发送短信
  • 提示
  • └ distance
  • Number
  • mailNo
  • 运单号
  • └ latitude
  • String
  • 12.4234
  • 经度
  • └ longitude
  • String
  • 12.4234
  • 纬度
  • └ mail_no
  • String
  • LP2143
  • 运单号
  • └ notification_count
  • Number
  • 2
  • 短信通知次数
  • └ order_id
  • Number
  • 23
  • 订单id
  • └ receiver_address
  • String
  • 文一西路969好
  • 收件人地址
  • └ receiver_name
  • String
  • 李希
  • 收件人姓名
  • └ receiver_phone
  • String
  • 13556333336
  • 收件人电话
  • └ last_sms_status
  • Number
  • 1
  • 最后一次短信发送状态
  • └ failed_sms_id
  • Number
  • 111111
  • 最后一次发送短信ID
status_code String success 状态码
status_message String 成功 消息
is_success Boolean false 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaDispatchListSpecifiedGetRequest req = new CainiaoYimaDispatchListSpecifiedGetRequest();
req.setUserId("2134");
req.setOrderIds("243,243");
CainiaoYimaDispatchListSpecifiedGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_dispatch_list_specified_get_response>
    <data>
        <doc_dispatch_item_list>
            <doc_daily_dispatch_item>
                <can_send_message>true</can_send_message>
                <cannot_notification_prompt>不能发送短信</cannot_notification_prompt>
                <distance>mailNo</distance>
                <latitude>12.4234</latitude>
                <longitude>12.4234</longitude>
                <mail_no>LP2143</mail_no>
                <notification_count>2</notification_count>
                <order_id>23</order_id>
                <receiver_address>文一西路969好</receiver_address>
                <receiver_name>李希</receiver_name>
                <receiver_phone>13556333336</receiver_phone>
                <last_sms_status>1</last_sms_status>
                <failed_sms_id>111111</failed_sms_id>
            </doc_daily_dispatch_item>
        </doc_dispatch_item_list>
    </data>
    <status_code>success</status_code>
    <status_message>成功</status_message>
    <is_success>false</is_success>
</cainiao_yima_dispatch_list_specified_get_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

返回
顶部