客户运营能力-查询订单列表:URI

时间:2024-12-24 10:04:20

URI

GET /v2/orders/customer-orders
表1 查询参数

参数

是否必选

参数类型

取值范围

描述

order_id

String

最大长度:64

订单ID。大小写不敏感。

此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。

说明:

使用特殊字符进行查询的时候,请注意进行URL编码转换,如“%”的转码应为“%25”。

customer_id

String

最大长度:64

客户账号ID。

此参数不携带时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空或携带值为空串。

create_time_begin

String

最大长度:20

订单创建开始时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

订单创建开始时间与订单创建结束时间间隔不能超过1年。

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

create_time_end

String

最大长度:20

订单创建结束时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

订单创建开始时间与订单创建结束时间间隔不能超过1年。

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

service_type_code

String

最大长度:64

云服务类型编码,例如OBS的云服务类型编码为"hws.service.type.obs"。大小写不敏感。

您可以调用查询云服务类型列表接口获取。

此参数不携带或携带值为空时,不作为筛选条件;携带值为空串或携带值为null时,作为筛选条件。

status

Integer

-

订单状态:

  • 1:待审核
  • 3:处理中
  • 4:已取消
  • 5:已完成
  • 6:待支付
  • 9:待确认

此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。

order_type

String

最大长度:64

订单类型:

  • 1:开通
  • 2:续订
  • 3:变更
  • 4:退订
  • 10:包年/包月转按需
  • 11:按需转包年/包月
  • 13:试用
  • 14:转商用
  • 15:费用调整

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

limit

Integer

[1-100]

每次查询的订单数量,默认值为10。

此参数不携带或携带值为空或携带值为null时,取默认值10;不支持携带值为空串。

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

此参数不携带或携带值为空或携带值为null时,取默认值0;不支持携带值为空串。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。

order_by

String

最大长度:36

查询的订单列表排序。大小写不敏感。

支持按照创建时间进行排序,带-表示倒序。

创建时间:升序为createTime,倒序为-createTime。

此参数不携带或携带值为空或携带值为空串或携带值为null时,按照创建时间倒序排列。

payment_time_begin

String

最大长度:20

订单支付开始时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

订单支付开始时间与订单支付结束时间间隔不能超过1年。

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

payment_time_end

String

最大长度:20

订单支付结束时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

订单支付开始时间与订单支付结束时间间隔不能超过1年。

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

support.huaweicloud.com/api-oce/api_order_00013.html