文档中心 > API类目 > iHome CBD API

alibaba.ihome.cbd.saas.hx.order.list.get (纯客户端软件场景,查询子订单列表)

大北窑项目,三方软件分页获取待处理的拆审单列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
data String 必须 {"dongleId":"abc","page":1,"pageSize":20} 业务关键数据:分页查询条件

响应参数

名称 类型 示例值 描述
result Result 接口返回model
  • data
  • Data
  • true
  • 返回素材id
  • └ total_size
  • Number
  • 102
  • 总记录数
  • data_list
  • SubOrder []
  • 子订单列表
  • └ sub_order_id
  • String
  • 躺平智造拆审平台的子订单ID
  • 子订单ID
  • └ handler_mobile
  • String
  • 门店处理人电话
  • 门店处理人电话
  • └ gmt_expect_delivery
  • Number
  • 1590741076894
  • 期待交付日期,时间戳
  • └ name
  • String
  • 子订单名称,一般可用来表示产品名称
  • 子订单名称
  • └ store_name
  • String
  • 门店名称
  • 门店名称
  • └ handler_name
  • String
  • 门店处理人姓名
  • 门店处理人姓名
  • └ gmt_commit
  • Number
  • 1590740976894
  • 门店提审日期,时间戳
  • └ remark
  • String
  • 备注
  • 备注
  • └ file_type
  • String
  • json
  • 订单的源文件类型
  • └ status
  • String
  • PHASE_AUDITING
  • 订单的状态
  • └ client_address
  • String
  • {"provinceName":"北京","provinceCode":"110000","cityName":"北京市","cityCode":"110100","districtName":"东城区","districtCode":"110101","streetName":"安定门街道","streetCode":"110101004","address":"测试小区 7幢3单元801"}
  • 客户的配送地址
  • └ client_mobile
  • String
  • 18777777777
  • 客户的联系方式
  • └ client_name
  • String
  • 李先生
  • 客户的姓名
  • └ store_outer_sub_order_id
  • String
  • ABC123
  • 子订单的门店侧自定义单号
  • └ page_size
  • Number
  • 20
  • 分页的页面大小
  • └ page
  • Number
  • 1
  • 分页的页码
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ error_code
  • String
  • isv.invalid-parameter
  • 错误码
  • └ error_msg
  • String
  • 参数错误
  • 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIhomeCbdSaasHxOrderListGetRequest req = new AlibabaIhomeCbdSaasHxOrderListGetRequest();
req.setData("{\"dongleId\":\"abc\",\"page\":1,\"pageSize\":20}");
AlibabaIhomeCbdSaasHxOrderListGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_ihome_cbd_saas_hx_order_list_get_response>
    <result>
        <data>
            <total_size>102</total_size>
            <data_list>
                <sub_order>
                    <sub_order_id>躺平智造拆审平台的子订单ID</sub_order_id>
                    <handler_mobile>门店处理人电话</handler_mobile>
                    <gmt_expect_delivery>1590741076894</gmt_expect_delivery>
                    <name>子订单名称,一般可用来表示产品名称</name>
                    <store_name>门店名称</store_name>
                    <handler_name>门店处理人姓名</handler_name>
                    <gmt_commit>1590740976894</gmt_commit>
                    <remark>备注</remark>
                    <file_type>json</file_type>
                    <status>PHASE_AUDITING</status>
                    <client_address>{&quot;provinceName&quot;:&quot;北京&quot;,&quot;provinceCode&quot;:&quot;110000&quot;,&quot;cityName&quot;:&quot;北京市&quot;,&quot;cityCode&quot;:&quot;110100&quot;,&quot;districtName&quot;:&quot;东城区&quot;,&quot;districtCode&quot;:&quot;110101&quot;,&quot;streetName&quot;:&quot;安定门街道&quot;,&quot;streetCode&quot;:&quot;110101004&quot;,&quot;address&quot;:&quot;测试小区 7幢3单元801&quot;}</client_address>
                    <client_mobile>18777777777</client_mobile>
                    <client_name>李先生</client_name>
                    <store_outer_sub_order_id>ABC123</store_outer_sub_order_id>
                </sub_order>
            </data_list>
            <page_size>20</page_size>
            <page>1</page>
        </data>
        <success>true</success>
        <error_code>isv.invalid-parameter</error_code>
        <error_msg>参数错误</error_msg>
    </result>
</alibaba_ihome_cbd_saas_hx_order_list_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

返回
顶部