查询订单列表
功能介绍
客户购买包年/包月资源后,可以查看待审核、处理中、已取消、已完成和待支付等状态的订单。
伙伴登录伙伴中心查看客户订单请单击这里。
如果想查询某条订单下的资源信息,在调用本接口获取订单ID后,请调用“查询客户包年/包月资源列表”接口在请求参数输入订单号进行查询。
接口约束
该接口既可以使用合作伙伴AK/SK或者Token调用,也可以使用客户AK/SK或者Token调用。用合作伙伴自身的AK/SK或者Token调用的情况下,可以查询伙伴所有客户的订单。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
order_id |
否 |
String |
最大长度:64 |
订单ID。大小写不敏感。 此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。
说明:
使用特殊字符进行查询的时候,请注意进行URL编码转换,如“%”的转码应为“%25”。 |
customer_id |
否 |
String |
最大长度:64 |
客户账号ID。您可以调用查询客户列表接口获取customer_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 |
- |
订单状态:
此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。 |
order_type |
否 |
String |
最大长度:64 |
订单类型:
此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为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。 |
indirect_partner_id |
否 |
String |
最大长度:64 |
云经销商ID。获取方法请参见查询云经销商列表。 华为云总经销商(一级经销商)查询云经销商的客户订单列表时,需要携带该参数,否则只能查询自己客户的订单列表。 此参数不携带或携带值为空时,不作为筛选条件;携带值为空串或携带值为null时,作为筛选条件。 |
method |
否 |
String |
最大长度:64 |
查询方式。
此参数不携带或携带值为空串或携带值为null时,默认值为“oneself”。 |
请求消息
请求参数
无。
请求示例
GET https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders?order_id=CS1905251035OA1AF&customer_id=c9e731c4663646988ef4cdb3122837b6&create_time_begin=2020-05-06T08:05:01Z&create_time_end=2020-05-07T08:05:01Z&service_type_code=hws.service.type.obs&status=5&order_type=1&limit=10&offset=0&order_by=-createTime&payment_time_begin=2020-05-06T08:05:01Z&payment_time_end=2020-05-07T08:05:01Z&indirect_partner_id=646988ef4cdb3122834feswrygfd HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:20 |
状态码。 具体请参见状态码。 |
error_msg |
String |
最大长度:2000 |
错误描述信息。 |
total_count |
Integer |
大于等于0的整数 |
大于等于0的整数。 符合条件的记录总数。 |
order_infos |
List<CustomerOrderV2> |
- |
客户订单详情信息。 具体请参见表2 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
order_id |
String |
最大长度:64 |
订单ID。 |
customer_id |
String |
最大长度:64 |
客户账号ID。 |
service_type_code |
String |
最大长度:64 |
云服务类型编码。例如OBS的云服务类型编码为“hws.service.type.obs”。 |
service_type_name |
String |
最大长度:200 |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
source_type |
Integer |
- |
客户订单订单来源类型:
|
status |
Integer |
- |
订单状态:
|
order_type |
Integer |
- |
订单类型:
|
official_amount |
Double |
- |
订单金额(官网价)。 退订订单中,该金额等于amount_after_discount。 |
amount_after_discount |
Double |
- |
订单优惠后金额(不含券不含卡的实付价格)。 |
measure_id |
Integer |
- |
订单金额度量单位:
|
create_time |
String |
最大长度:20 |
创建时间 。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 |
payment_time |
String |
最大长度:20 |
支付时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 |
currency |
String |
最大长度:4 |
货币编码。 |
contract_id |
String |
最大长度:64 |
合同ID。 |
amount_info |
AmountInfoV2 Object |
- |
订单扣费详情。 具体请参见表3。 |
enterprise_projects |
List<EnterpriseProject> |
- |
客户订单企业项目详情信息。 具体请参见表5。
说明:
批量退订、续订场景下各订单的企业项目信息,可通过各订单ID区分查询。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
discounts |
List<DiscountItemV2> |
- |
费用项。 具体请参见表4。 |
flexipurchase_coupon_amount |
Double |
- |
现金券金额,预留。 |
coupon_amount |
Double |
- |
代金券金额。 |
stored_card_amount |
Double |
- |
储值卡金额,预留。 |
commission_amount |
Double |
- |
手续费(仅退订订单存在)。 |
consumed_amount |
Double |
- |
消费金额(仅退订订单存在)。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
discount_type |
String |
最大长度:8 |
折扣类型:
|
discount_amount |
Double |
- |
折扣金额。 |
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 1, "order_infos": [ { "order_id": "CS2405161952CE7IU5QmodifyJobAndPartFailJob", "customer_id": "0c7fd9bdfb80d4170fb1c0056128d420", "service_type_code": "hws.service.type.ec2", "service_type_name": "弹性云服务器", "source_type": 1, "status": 5, "order_type": 1, "amount_after_discount": 274.6, "official_amount": 349.5, "measure_id": 1, "create_time": "2024-05-16T11:52:10Z", "payment_time": "2024-05-16T12:18:35Z", "currency": "USD", "contract_id": null, "amount_info": { "discounts": [ { "discount_type": "700", "discount_amount": 69.9 }, { "discount_type": "301", "discount_amount": 5.0 } ], "flexipurchase_coupon_amount": 0.0, "coupon_amount": 5.0, "stored_card_amount": 0.0, "commission_amount": null, "consumed_amount": null }, "enterprise_projects": [ { "id": "0", "name": "default" } ] } ] }