You are not logged in.
ListCustomerOrders
After a customer purchases yearly/monthly resources, it can query the orders in different statuses, such as in the pending approval, processing, canceled, completed, and pending payment statuses.
A partner can log in to Partner Center and follow the instructions described in Viewing a Customer's Orders to view orders of a customer.
NOTE:
If you want to query the resource information of a specified order, invoke this API to obtain the order ID and then invoke the API described in Querying Customer's Yearly/Monthly Resources. Enter the order ID in the request to query the resource information.
This API can be invoked using the AK/SK or token of the partner or of the partner's customer.
Name | Type | IN | Mandatory | Description |
---|---|---|---|---|
X-Auth-Token | string | header | Yes | Call with partner or customer token |
method | string | query | No | Query method.oneself: Query your own orders.sub_customer: Query customer orders that are paid for by you. |
indirect_partner_id | string | query | No | Reseller ID. |
payment_time_end | string | query | No | End time of order payment. UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01ZThe range of HH is 0-23, and the range of mm and ss is 0-59. |
payment_time_begin | string | query | No | Start time of order payment.UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01ZThe range of HH is 0-23, and the range of mm and ss is 0-59. |
order_by | string | query | No | Sorting order of the orders.You can sort the orders by creation time.If you set the value to createTime, the system sorts orders by creation time in ascending order. If you set the value to -createTime, the system sorts orders by creation time in descending order. |
offset | integer | query | No | Offset, which starts from 0. The default value is 0. 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, there are 10 data records, and if you set limit to 10 and offset to 1, the second to the tenth data records are returned. |
limit | integer | query | No | Number of orders queried each time. The default value is 10. |
order_type | string | query | No | Order type. The value can be:1: New purchase2: Renewal3: Change4: Unsubscription11: Pay-per-use to yearly/monthly13: Trial14: Commercial use15: Price adjustment |
status | integer | query | No | Order status. The value can be:1: Pending approval3: Processing4: Canceled5: Completed6: Pending payment9: To be confirmed |
service_type_code | string | query | No | 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. |
create_time_end | string | query | No | End time of order creation.UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01ZThe range of HH is 0-23, and the range of mm and ss is 0-59. |
create_time_begin | string | query | No | Start time of order creation.UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, such as 2019-05-06T08:05:01ZThe range of HH is 0-23, and the range of mm and ss is 0-59. |
customer_id | string | query | No | Customer account ID. To obtain the customer ID, call the API in Querying Customers. |
order_id | string | query | No | Order ID. NOTE: When special characters are used for query, perform the URL code conversion. For example, % should be converted to %25. |
ListCustomerOrders Responses
Name | Type | Description |
---|---|---|
total_count | integer | An integer greater than or equal to 0. Number of records that match the query conditions. |
order_infos | Array of CustomerOrderV2 objects |
|
Name | Type | Description |
---|---|---|
order_id | string | Order ID |
customer_id | string | 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. To obtain a specific service type, call the API in Querying Cloud Service Types. |
service_type_name | string | 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. Customer2. Agent3: Contract4: Distributor |
status | integer | Order status. The value can be: 1: Pending approval3: Processing4: Canceled5: Completed6: Pending payment9: To be confirmed |
order_type | integer | Order type. The value can be: 1: New purchase2: Renewal3: Change4: Unsubscription11: Pay-per-use to yearly/monthly13: Trial14: Commercial use15: Price adjustment |
amount_after_discount | double | Order amount after a discount (excluding the vouchers or cards). |
official_amount | double | Order amount (list price). In the unsubscription order, this amount equals the value of amount_after_discount. |
measure_id | integer | Order amount unit. 1: 1 Yuan/Dollar |
create_time | string | 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 | 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. |
currency | string | Currency code. |
contract_id | string | Contract ID. |
amount_info | AmountInfomationV2 object | Order deduction details, see Table 3. |
enterprise_projects | Array of EnterpriseProject objects | Enterprise project details of a customer order.For details, see Table EnterpriseProject. |
sub_order_infos | Array of SubCustomerOrderV2 objects | Details of orders in a combined order.For details, see Table SubCustomerOrderV2. |
Name | Type | Description |
---|---|---|
discounts | Array of DiscountItemV2 objects | Fee item. For details, see Table 7. |
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 | Consumptions (only for unsubscription orders). |
Name | Type | Description |
---|---|---|
discount_type | string | Discount type. 200: Promotion product discount300: Promotion discount coupon301: Promotion coupon302: Promotion flexi-purchase coupon500: Specified discount for agent subscription501: Specified exemption for agent subscription502: Specified buy-it-now price for agent subscription600: Discount specified in the discount and rebate contract601: Discount specified in the channel frame contract602: Discount specified in the designated-purpose fund contract603: Discount specified in the directly signed offline contract604: Discount specified in the authorized telemarketing contract605: Discount specified in the commercial contract606: Discount specified in the channel commercial contract607: Partner authorized discount609: Discount for order price adjusting610: Discount amount700: Promotion discount800: Top-up account discount900: Product discount901: Buy-it-now price based on the benchmark price |
discount_amount | double | Discounted amount. |
Name | Type | Description |
---|---|---|
id | string | Enterprise project ID. |
name | string | Enterprise project name. |
Name | Type | Description |
---|---|---|
order_id | string | Order ID |
customer_id | string | 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. To obtain a specific service type, call the API in Querying Cloud Service Types. |
service_type_name | string | 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. Customer2. Agent3: Contract4: Distributor |
status | integer | Order status. The value can be: 1: Pending approval3: Processing4: Canceled5: Completed6: Pending payment9: To be confirmed |
order_type | integer | Order type. The value can be: 1: New purchase2: Renewal3: Change4: Unsubscription11: Pay-per-use to yearly/monthly13: Trial14: Commercial use15: Price adjustment |
amount_after_discount | double | Order amount after a discount (excluding the vouchers or cards). |
official_amount | double | Order amount (list price). In the unsubscription order, this amount equals the value of amount_after_discount. |
measure_id | integer | Order amount unit. 1: 1 Yuan/Dollar |
create_time | string | 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 | 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. |
currency | string | Currency code. |
contract_id | string | Contract ID. |
amount_info | AmountInfomationV2 object | Order deduction details, see Table 3 |
enterprise_projects | Array of EnterpriseProject objects | Enterprise project details of a customer order.For details, see Table EnterpriseProject. |
Name | Type | Description |
---|---|---|
discounts | Array of DiscountItemV2 objects | Fee item. For details, see Table 7. |
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 | Consumptions (only for unsubscription orders). |
Name | Type | Description |
---|---|---|
discount_type | string | Discount type. 200: Promotion product discount300: Promotion discount coupon301: Promotion coupon302: Promotion flexi-purchase coupon500: Specified discount for agent subscription501: Specified exemption for agent subscription502: Specified buy-it-now price for agent subscription600: Discount specified in the discount and rebate contract601: Discount specified in the channel frame contract602: Discount specified in the designated-purpose fund contract603: Discount specified in the directly signed offline contract604: Discount specified in the authorized telemarketing contract605: Discount specified in the commercial contract606: Discount specified in the channel commercial contract607: Partner authorized discount609: Discount for order price adjusting610: Discount amount700: Promotion discount800: Top-up account discount900: Product discount901: Buy-it-now price based on the benchmark price |
discount_amount | double | Discounted amount. |
Name | Type | Description |
---|---|---|
id | string | Enterprise project ID. |
name | string | Enterprise project name. |
CBC.0100:Parameter error.
"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=-2BcreateTime&payment_time_begin=2020-05-06T08:05:01Z&payment_time_end=2020-05-07T08:05:01Z&indirect_partner_id=646988ef4cdb3122834feswrygfd"
ListCustomerOrders Responses
{
"total_count": 1,
"order_infos": [
{
"order_id": "CS1905251035OA1AF",
"customer_id": "17a80a9f9d3949ddb60ee73a5b3c9618",
"service_type_code": "hws.service.type.rds",
"source_type": 1,
"status": 5,
"order_type": 1,
"amount_after_discount": 0,
"official_amount": 100,
"measure_id": 1,
"create_time": "2020-05-06T09:08:03Z",
"payment_time": "2020-05-06T09:08:03Z",
"currency": "USD",
"contract_id": null,
"amount_info": {
"discounts": [
{
"discount_type": "700",
"discount_amount": 15
},
{
"discount_type": "302",
"discount_amount": 85
}
],
"flexipurchase_coupon_amount": 85,
"coupon_amount": 0,
"stored_card_amount": 0,
"commission_amount": null,
"consumed_amount": null
},
"enterprise_projects": [
{
"id": "0",
"name": "default"
}
]
}
]
}