工业订单服务查询列表接口

路径 /industry/order/list/query
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
pageSize Int 1 分页大小
pageNo Int 1 页码
buyerNick String 张三 买家昵称
recipientPhone String 18888888888 联系人昵称
orderId String 1234567 订单号
bizSource Int 2 业务来源(0=自建订单;2=天天特卖)
companyName String 阿里巴巴 公司名称
externalId String 1234567 外部单号
recipientName String 张三 联系人姓名
produceStatus Int 1 订单状态(0=未完成;1=已完成;2=生产中;3=已排产;4=已关闭)
beginTime Long 时间戳 开始时间
endTime Long 时间戳 结束时间
cropId String 98767 企业唯一标识:如钉钉里的cropId,LH里的appId
userId String 876789 员工唯一标识:钉钉的userId、IOT的employeeId
source String DINGDING 钉钉填写DINGDING,多租户saas填写SAAS

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

total Long

总数

pageNo Int

页码

pageSize Int

分页大小

dataList JSON

订单列表

orderId String

订单号

externalId String

外部订单号

companyName String

公司名

recipientName String

收货人姓名

recipientProvince String

收货省

recipientCity String

收货市

recipientDistrict String

收货区县

recipientAddress String

收货地址

recipientCode String

收货邮编

recipientPhone String

收货电话

totalAmount String

订单总数

totalPrice String

订单总金额

contractType Int

合同类型(1="打样";2="大货")

workingType Int

加工类型(1="包工包料";2="清加工";3="指定供应商")

orderTime Long

下单时间

dueTime Long

交货日期

remark String

备注

bizSource Int

业务来源(0=自建订单;2=天天特卖)

produceStatus Int

订单状态(0=未完成;1=已完成;2=生产中;3=已排产;4=已关闭)

annexesJson String

附件列表

orderProductDTOs JSON

产品列表

price String

货品单价

amount String

货品数量

productCode String

产品编码

productName String

产品名称

productModel String

产品型号

materialType String

物料类型编码

materialTypeName String

物料类型名称

measureUnit String

基本计量单位

processFlow String

工业路径编码

processFlowName String

工艺路径名称

productDesc String

产品描述

productStatus Int

产品状态

source String

数据来源

picturesJson String

图片列表

annexesJson String

附件列表

customPropertiesJson String

扩展属性

示例

请求示例

// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();

ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");

SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);

IoTApiRequest request = new IoTApiRequest();

// 设置请求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 设置API版本号
request.setApiVer("1.0.1");

// 设置参数
request.putParam("pageSize", "value0");
request.putParam("pageNo", value1");
request.putParam("buyerNick", value2");
request.putParam("recipientPhone", value3");
request.putParam("orderId", value4");
request.putParam("bizSource", value5");
request.putParam("companyName", value6");
request.putParam("externalId", value7");
request.putParam("recipientName", value8");
request.putParam("produceStatus", value9");
request.putParam("beginTime", value10");
request.putParam("endTime", value11");
request.putParam("cropId", value12");
request.putParam("userId", value13");
request.putParam("source", value14");
// 如果需要,设置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");

// 设置请求参数域名, path, request, isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/industry/order/list/query", request, true, headers);

System.out.println(
    "response code = " + response.getCode()
        + " response = " + new String(response.getBody(), "UTF-8")
        + " headers = " + response.getHeaders().toString()
);

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "total":1000,
        "pageNo":1,
        "pageSize":10,
        "dataList":[
            {
                "annexes":[
                    "http://file.com/123",
                    "http://file.com/123"
                ],
                "companyName":"采购公司名称",
                "contractType":2,
                "dueTime":1560851982974,
                "externalId":"外部订单号",
                "orderId":123456789123456780,
                "orderProductDTOs":[
                    {
                        "amount":100000000,
                        "price":"8888.8888",
                        "productId":123456
                    }
                ],
                "orderTime":1560851982944,
                "recipientAddress":"详细地址",
                "recipientCity":"杭州",
                "recipientDistrict":"余杭",
                "recipientName":"收货人姓名",
                "recipientPhone":"收货人手机",
                "recipientProvince":"浙江",
                "remark":"备注",
                "totalAmount":"100000件",
                "totalPrice":8888888888888,
                "workingType":2
            }
        ]
    }
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 22000 Query Result is Empty 查询结果为空
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 服务错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 500 server error. 系统错误
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误