查询订单详情
接口约束
该接口可以使用合作伙伴自身的AK/SK或者Token调用,也可以用客户的AK/SK或者Token来调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/orders/customer-orders/details/{order_id}
参数说明请参见下表。
参数 |
是否必选 |
取值范围 |
描述 |
---|---|---|---|
offset |
否 |
[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。 |
limit |
否 |
[1-100] |
每页大小。默认值为10。 此参数不携带或携带值为空或携带值为null,取默认值10。 |
indirect_partner_id |
否 |
最大长度:64 |
云经销商ID。获取方法请参见查询云经销商列表。 华为云总经销商(一级经销商)查询云经销商的客户订单详情时,需要携带该参数;除此之外,此参数不做处理。否则只能查询自己客户的订单详情。 |
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
X-Language |
否 |
String |
最大长度:10 |
语言。
缺省为zh_CN。 |
请求消息
请求参数
无
请求示例
GET https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/details/CS19040119281JMYC?limit=10&offset=0&indirect_partner_id=c9e731c4663646988ef4cdb3122837b6 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:20 |
状态码。 具体请参见状态码。 |
error_msg |
String |
最大长度:2000 |
错误描述信息。 |
order_info |
CustomerOrderEntityV2 Object |
- |
订单详单。 具体请参见表4。 |
total_count |
Integer |
- |
订单项个数。 |
order_line_items |
List<OrderLineItemEntityV2> |
- |
订单对应的订单项。 具体请参见表5。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
order_id |
String |
最大长度:64 |
订单ID。 |
customer_id |
String |
最大长度:64 |
客户账号ID。 |
service_type_code |
String |
- |
云服务类型编码。例如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。 |
amount_info |
AmountInfoV2 Object |
- |
订单扣费详情。 具体请参见表7。 |
currency |
String |
最大长度:4 |
货币编码。 |
contract_id |
String |
最大长度:64 |
合同ID。 |
user_name |
String |
最大长度:64 |
订单创建者名称。
|
pending_payment_end_time |
String |
最大长度:20 |
订单待付款截止时间 。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。
说明:
仅当订单状态为待付款时,参数返回具体值。其他订单状态,参数取值为null。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
order_line_item_id |
String |
最大长度:64 |
订单项ID。 |
service_type_code |
String |
最大长度:64 |
云服务类型编码。例如OBS的云服务类型编码为“hws.service.type.obs”。 |
service_type_name |
String |
最大长度:200 |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
product_id |
String |
最大长度:64 |
产品ID。 |
product_spec_desc |
String |
最大长度:512 |
产品规格描述。 |
period_type |
Integer |
- |
周期类型。
|
period_num |
Integer |
- |
周期数量。
说明:
当订单为退订资源的订单时,参数取值为null。 |
effective_time |
String |
最大长度:20 |
生效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 |
expire_time |
String |
最大长度:20 |
失效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 |
subscription_num |
Integer |
- |
订购数量。 |
amount_after_discount |
Double |
- |
订单优惠后金额(实付价格,不含券不含卡)。 退订订单中,该金额为去除手续费后退款金额。 |
official_amount |
Double |
- |
订单金额(官网价)。 退订订单中,该金额等于amount_after_discount。 |
amount_info |
AmountInfoV2 Object |
- |
订单扣费详情。 具体请参见表7。 |
currency |
String |
最大长度:4 |
货币编码。 |
category_code |
String |
最大长度:64 |
产品目录编码。 |
product_owner_service |
String |
最大长度:64 |
产品归属的云服务类型编码。 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 |
commercial_resource |
string |
最大长度:64 |
商务归属的资源类型编码。 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 |
base_product_info |
BaseProductInfo Object |
-- |
变更前订单行产品信息。 具体请参见表 BaseProductInfo。
说明:
仅当订单类型为变更时,参数返回具体值。其他订单类型,参数取值为null。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
product_id |
String |
最大长度:64 |
产品ID。 |
product_spec_desc |
String |
最大长度:512 |
产品规格描述。 |
category_code |
String |
最大长度:64 |
产品目录编码。 |
product_owner_service |
String |
最大长度:64 |
产品归属的云服务类型编码。 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 |
commercial_resource |
string |
最大长度:64 |
商务归属的资源类型编码。 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
discounts |
List<DiscountItemV2> |
- |
费用项。 具体请参见表8。 |
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": 2, "order_info": { "order_id": "CS18122203217MRPB", "customer_id": "982f05775ec94da390c3f174b058fb46", "service_type_code": "hws.service.type.obs", "source_type": 1, "status": 5, "order_type": 4, "amount_after_discount": -277.92, "official_amount": -277.92, "measure_id": 1, "create_time": "2018-12-21T19:21:03Z", "payment_time": null, "currency": "USD", "contract_id": null, "amount_info": { "discounts": [], "flexipurchase_coupon_amount": null, "coupon_amount": null, "stored_card_amount": null, "commission_amount": 30.88, "consumed_amount": 0.0 }, "user_name": "h******55", "pending_payment_end_time": "2024-11-14T15:59:59Z" }, "order_line_items": [ { "order_line_item_id": "CS18122203217MRPB-000001", "service_type_code": "hws.service.type.ebs", "product_id": "00301-01026-0--1", "product_spec_desc": "High IO|40.0GB", "period_type": 3, "period_num": null, "effective_time": "2018-12-21T19:21:03Z", "expire_time": "2019-12-22T15:59:59Z", "subscription_num": 1, "amount_after_discount": -33.12, "official_amount": -33.12, "amount_info": { "discounts": [], "flexipurchase_coupon_amount": null, "coupon_amount": null, "stored_card_amount": null, "commission_amount": 3.68, "consumed_amount": 0.0 }, "currency": "USD", "category_code": "hws.resource.storage1.evs", "product_owner_service": null, "commercial_resource": null }, { "order_line_item_id": "CS18122203217MRPB-000002", "service_type_code": "hws.service.type.ec2", "product_id": "00301-02019-0--1", "product_spec_desc": "General Computing|s2.medium.4|1vCPUs|4GB|linux", "period_type": 3, "period_num": null, "effective_time": "2018-12-21T19:21:03Z", "expire_time": "2019-12-22T15:59:59Z", "subscription_num": 1, "amount_after_discount": -244.8, "official_amount": -244.8, "amount_info": { "discounts": [], "flexipurchase_coupon_amount": null, "coupon_amount": null, "stored_card_amount": null, "commission_amount": 27.2, "consumed_amount": 0.0 }, "currency": "USD", "category_code": "hws.resource.computing.ecs", "product_owner_service": null, "commercial_resource": null, "base_product_info": { "product_id": "00301-238595-0--0", "product_spec_desc": "通用计算型|s3.small.1|1vCPUs|1GB|linux", "category_code": "hws.resource.computing.ecs", "product_owner_service": "hws.service.type.ec2", "commercial_resource": null } } ] }
状态码
- 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
- 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。
HTTP状态码 |
错误码 |
描述 |
---|---|---|
400 |
CBC.0100 |
参数错误。 |
400 |
CBC.0101 |
参数无效。 |
400 |
CBC.99000037 |
您没有操作该云经销商的权限。 |
400 |
CBC.30000010 |
无效订单(可能是订单不存在),不能进行操作。 |
403 |
CBC.0155 |
不允许执行当前请求。 原因可能为账号鉴权信息不正确、账号或子账号没有接口调用权限。 |
500 |
CBC.0999 |
其他错误。 |