Querying Order Details

Function

Customers can view order details on the self-built platform.

For details about how to view order details in Billing Center, see Viewing Order Details.

If you want to query the resource information of a specified order, invoke the API described in Querying Customer's Yearly/Monthly Resources and enter the order ID in the request to query the resource information.

Constraints

This API can be invoked using the customer AK/SK or token.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

GET /v2/orders/customer-orders/details/{order_id}

The following table describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Value Range	Description
order_id	Yes	A maximum of 64 characters	Order ID. The system will return the orders if the orders are queried.

**Table 2** Query parameters
Parameter	Mandatory	Value Range	Description
offset	No	0 to a maximum integer	Offset, which starts from 0. The default value is 0. If this parameter is not included in the request parameters, is set to "", or is set to null, the default value 0 is used. NOTE: This parameter is used for pagination. Retain its default value 0 if pagination is not required. offset indicates the offset relative to the first data record among all that meets the conditions configured. If you set offset to 1, the second and subsequent data records are returned. For example, if there are 10 records that meet query conditions, when you set limit to 10 and offset to 1, the second to the tenth records are returned. If there are 20 records that meet query conditions, when you set offset to 0 and limit to 10 for the first page and set offset to 10 and limit to 10 for the second page, then each page will respectively have 10 records.
limit	No	1 to 100	Number of records displayed per page. The default value is 10. If this parameter is not included in the request parameters, is set to "", or is set to null, the default value 10 is used.

**Table 3** Message header parameter
Parameter	Mandatory	Type	Value Range	Description
X-Language	No	String	A maximum of 10 characters	Language. zh_CN: Chinese en_US: English Default value: zh_CN

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/details/CS19040119281JMYC?limit=10&offset=0 HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Response

Response Parameters

Parameter	Type	Value Range	Description
error_code	String	A maximum of 20 characters	Status code. For details, see Returned Values.
error_msg	String	A maximum of 2,000 characters	Error description.
order_info	CustomerOrderEntityV2 Object	-	Order details. For details, see Table 4.
total_count	Integer	-	Order item ID array.
order_line_items	List<OrderLineItemEntityV2>	-	ID of the primary order item mapping the order item. For details, see Table 5.

**Table 4** CustomerOrderEntityV2
Parameter	Type	Maximum Length	Description
order_id	String	64	Order ID.
customer_id	String	A maximum of 64 characters	Customer account ID.
service_type_code	String	-	Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs.
service_type_name	String	A maximum of 200 characters	Cloud service type. For example, the cloud service type of ECS is Elastic Cloud Server.
source_type	Integer	-	Customer order source type. The value can be: 1. Customer 2. Agent 3: Contract 4: Distributor
status	Integer	-	Order status. The value can be: 1: Pending approval 2: Pending refund 3: Processing 4: Canceled 5: Completed 6: Pending payment 9: To be confirmed 10: To be shipped 11: To be received 12: Pending pick-up 13: Exchange in progress
order_type	Integer	-	Order type. The value can be: 1: New purchase 2: Renewal 3: Change 4: Unsubscription 10: Yearly/monthly to pay-per-use 11: Pay-per-use to yearly/monthly 13: Trial 14: Commercial use 15: Price adjustment
official_amount	Double	-	Order amount (list price). In the unsubscription order, this amount equals the value of amount_after_discount.
amount_after_discount	Double	-	Order amount after a discount (excluding the vouchers or cards). In the unsubscription order, the amount is the refund amount after the handling fee is deducted.
measure_id	Integer	-	Order amount unit. 1: 1 Yuan/Dollar
create_time	String	A maximum of 20 characters	Creation time. UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01Z The range of HH is 0-23, and the range of mm and ss is 0-59.
payment_time	String	A maximum of 20 characters	Payment time. UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01Z The range of HH is 0-23, and the range of mm and ss is 0-59.
amount_info	AmountInfoV2 Object	-	Order deduction details. For details, see Table 7.
currency	String	A maximum of 4 characters	Currency code.
contract_id	String	A maximum of 64 characters	Contract ID.
user_name	String	A maximum of 64 characters	Order creator name If the order is placed by the customer, the login name of the operator who places the order is returned. If the order is placed by the operation personnel at the background, Operation personnel is returned. If the order is automatically placed by the operation system, Operation system is returned.
pending_payment_end_time	String	A maximum of 20 characters	Payment end time of an unpaid order. UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01Z The range of HH is 0–23, and the range of mm and ss is 0–59. NOTE: A specific value is returned only when the order is in the pending payment state. For other order statuses, the value is null.

**Table 5** OrderLineItemEntityV2
Parameter	Type	Value Range	Description
order_line_item_id	String	A maximum of 64 characters	Order ID.
service_type_code	String	A maximum of 64 characters	Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs.
service_type_name	String	A maximum of 200 characters	Cloud service type. For example, the cloud service type of ECS is Elastic Cloud Server.
product_id	String	A maximum of 64 characters	Product ID.
product_spec_desc	String	A maximum of 512 characters	Product specification description.
period_type	Integer	-	Period type. The options are as follows: 0: Day 1: Week 2: Month 3: Year 4: Hour 5: One-off 6: Pay-per-use (reserved) 7: By usage report (reserved)
period_num	Integer	-	Number of periods. NOTE: The value of this parameter is null for an unsubscription order.
effective_time	String	A maximum of 20 characters	Effective time. UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01Z The range of HH is 0-23, and the range of mm and ss is 0-59.
expire_time	String	A maximum of 20 characters	Expiration time. UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01Z The range of HH is 0-23, and the range of mm and ss is 0-59.
subscription_num	Integer	-	Number of subscriptions.
amount_after_discount	Double	-	Order amount after a discount (excluding the vouchers or cards). In the unsubscription order, the amount is the refund amount after the handling fee is deducted.
official_amount	Double	-	Order amount (list price). In the unsubscription order, this amount equals the value of amount_after_discount.
amount_info	AmountInfoV2 Object	-	Order deduction details. For details, see Table 7.
currency	String	A maximum of 4 characters	Currency code.
category_code	String	A maximum of 64 characters	Product catalog code.
product_owner_service	String	A maximum of 64 characters	Type code of a cloud service. Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs. To obtain a specific service type, call the API in Querying Cloud Service Types.
commercial_resource	string	A maximum of 64 characters	Type code of a commercial resource. Resource type code. For example, the VM resource type code of ECS is hws.resource.type.vm. To obtain a specific resource type, call the API in Querying Resource Types.
base_product_info	BaseProductInfo Object	--	Product information in the order line before the change. For details, see Table 6. NOTE: A specific value is returned only when the order_type is set to Change. For other order types, the value is null.

**Table 6** BaseProductInfo
Parameter	Type	Maximum Length	Description
product_id	String	A maximum of 64 characters	Product ID.
product_spec_desc	String	A maximum of 512 characters	Product specification description.
category_code	String	A maximum of 64 characters	Product catalog code.
product_owner_service	String	A maximum of 64 characters	Type code of a cloud service. Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs. To obtain a specific service type, call the API in Querying Cloud Service Types.
commercial_resource	string	A maximum of 64 characters	Type code of a commercial resource. Resource type code. For example, the VM resource type code of ECS is hws.resource.type.vm. To obtain a specific resource type, call the API in Querying Resource Types.

**Table 7** AmountInfoV2
Parameter	Type	Value Range	Description
discounts	List<DiscountItemV2>	-	Fee item. For details, see Table 8.
flexipurchase_coupon_amount	Double	-	Flexi-purchase coupon amount (reserved).
coupon_amount	Double	-	Cash coupon amount.
stored_card_amount	Double	-	Stored-value card amount (reserved).
commission_amount	Double	-	Handling fee (only for unsubscription orders).
consumed_amount	Double	-	Consumption amount (only for unsubscription orders).

**Table 8** DiscountItemV2
Parameter	Type	Maximum Length	Description
discount_type	String	A maximum of 8 characters	Discount type. 200: Promotion product discount 300: Promotion discount coupon 301: Promotion coupon 302: Promotion flexi-purchase coupon 500: Specified discount for agent subscription 501: Specified exemption for agent subscription 502: Specified buy-it-now price for agent subscription 600: Discount specified in the discount and rebate contract 601: Discount specified in the channel frame contract 602: Discount specified in the designated-purpose fund contract 603: Discount specified in the directly signed offline contract 604: Discount specified in the authorized telemarketing contract 605: Discount specified in the commercial contract 606: Discount specified in the channel commercial contract 607: Partner authorized discount 609: Discount for order price adjusting 610: Discount amount 700: Promotion discount 800: Top-up account discount
discount_amount	Double	-	Discounted amount.

Example Response

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 I/O|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": "General computing | s3.small.1 | 1 vCPU| 1 GB | Linux",
                "category_code": "hws.resource.computing.ecs",
                "product_owner_service": "hws.service.type.ec2",
                "commercial_resource": null
            }
        }
    ]
}

Returned Values

4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

HTTP Status Code	Error Code	Description
400	CBC.0100	Incorrect parameter.
400	CBC.0101	Invalid parameter.
400	CBC.30000010	Operation not supported because the order is invalid or does not exist.
403	CBC.0155	Request denied. The possible causes are as follows: The account authentication information is incorrect. The account or member account does not have the permission to call the API.
500	CBC.0999	Other errors.