Customer Operation Capabilities
| Details
  • Registering a Customer (Partner)
    • CheckUserIdentity
    • CreateSubCustomer
    • SendVerificationMessageCode
  • Managing Customers (Partner)
    • FreezeSubCustomers
    • ListSubCustomers
    • UnfreezeSubCustomers
  • Real-Name Authentication (Partner)
    • ChangeEnterpriseRealnameAuthentication
    • CreateEnterpriseRealnameAuthentication
    • CreatePersonalRealnameAuth
    • ShowRealnameAuthenticationReviewResult
  • Managing Coupons (Public)
    • ListSubCustomerCoupons
  • Managing Customer Budgets (Partner)
    • ListSubCustomerBudget
    • ShowSubCustomerBudget
    • UpdateSubCustomerBudget
  • Managing Accounts (Customer)
    • ShowCustomerAccountBalances
  • Purchasing a Cloud Service (Public)
    • ListFreeResourceUsages
    • ListOnDemandResourceRatings
    • ListRateOnPeriodDetail
    • ListRenewRateOnPeriod
  • Managing Yearly/Monthly Orders (Public)
    • ListCustomerOrders
    • ShowCustomerOrderDetails
    • ShowRefundOrderDetails
  • Managing Yearly/Monthly Orders (Customer)
    • AutoRenewalResources
    • CancelAutoRenewalResources
    • CancelCustomerOrder
    • CancelResourcesSubscription
    • ListOrderDiscounts
    • ListPayPerUseCustomerResources
    • PayOrders
    • RenewalResources
    • UpdatePeriodToOnDemand
  • Managing Pay-Per-Use Resources (Partner)
    • ListCustomerOnDemandResources
  • Managing Bills (Partner)
    • ListPostpaidBillSum
  • Managing Bills (Customer)
    • ListCustomerselfResourceRecordDetails
    • ListCustomerselfResourceRecords
    • ListMonthlyExpenditures
  • Managing Enterprise Projects (Customer)
    • CreateEnterpriseProjectAuth
  • Managing Enterprise Accounts (Customer)
    • ListEnterpriseSubCustomers
  • Managing Products (Public)
    • ListConversions
    • ListMeasureUnits
    • ListResourceTypes
    • ListServiceResources
    • ListServiceTypes
    • ListUsageTypes
  • Managing Resource Packages (Customer)
    • ListFreeResourceInfos
    • ListFreeResourcesUsageRecords
  • Managing Huawei Cloud Resellers (Partner)
    • ListIndirectPartners
  • Cost Management (Customer)
    • ListCosts
  • Managing Credits(Partner)
    • ShowPartnerConsumptionQuota
  • Managing Invoices (Public)
    • ListInvoices

ShowCustomerOrderDetails

GET
https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/details/{order_id}
Advanced
Required parameters only
Default
Encrypt sensitive parameters
*
Region
Headers
*
Authorization
*
X-Language
Parameters
*
order_id
*
limit
*
offset
*
indirect_partner_id
API Description

Customers can view order details on the partner sales platform.

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

NOTE:

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 AK/SK or token of the partner or of the partner's customer.

URL
GET  https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/details/{order_id}
Request Parameters
NameTypeINMandatoryDescription
X-Language
stringheader No

Language.en_US: English.zh_CN: Chinese.If this parameter is not set, the default value Chinese is used

X-Auth-Token
stringheader Yes

Call with partner or customer token

order_id
stringpath Yes

Order ID.The system will return the orders if the orders are queried.

indirect_partner_id
stringquery No

Reseller ID.This parameter is mandatory only when a distributor queries order details of customers associated with its resellers. Otherwise, the order details of the distributor's own customers will be queried.

offset
integerquery 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
integerquery No

Number of records displayed per page. The default value is 10.

Response Parameters
Status code: 200

ShowCustomerOrderDetails Responses

NameTypeDescription
total_count
integer

Order item ID array.

order_info
CustomerOrderV3 object

Order details. For details, see Table 4.

order_line_items
Array of OrderLineItemEntityV2 objects

ID of the primary order item mapping the order item. For details, see Table 5.

200 order_info
NameTypeDescription
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, the amount is equal to the value of currencyAfterDiscount.

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. For details, see Table 6.

user_name
string

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

Payment end time of an unpaid order.

sub_order_infos
Array of SubCustomerOrderV3 objects

Details of orders in a combined order.For details, see Table SubCustomerOrderEntityV2.

200 order_info.amount_info
NameTypeDescription
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).

200 order_info.amount_info.discounts
NameTypeDescription
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.

200 order_info.sub_order_infos
NameTypeDescription
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, the amount is equal to the value of currencyAfterDiscount.

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. For details, see Table 6.|

user_name
string

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

Payment end time of an unpaid order.

200 order_info.sub_order_infos.amount_info
NameTypeDescription
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).

200 order_info.sub_order_infos.amount_info.discounts
NameTypeDescription
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.

200 order_line_items
NameTypeDescription
order_line_item_id
string

Order 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.

product_id
string

Product ID.

product_spec_desc
string

Product specification description.

period_type
integer

Period type. The options are as follows: 0: Day1: Week2: Month3: Year4: Hour5: One-off6: 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

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

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).

official_amount
double

Order amount (list price). In the unsubscription order, the amount is equal to the value of currencyAfterDiscount.

amount_info
AmountInfomationV2 object

Order deduction details. For details, see Table 6.

currency
string

Currency code.

category_code
string

Product catalog code.

product_owner_service
string

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

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
ProductObject object

Product information in the order line before the change.For details, see Table BaseProductInfo.

order_id
string

Order ID.

200 order_line_items.amount_info
NameTypeDescription
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).

200 order_line_items.amount_info.discounts
NameTypeDescription
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.

200 order_line_items.base_product_info
NameTypeDescription
product_id
string

Product ID.

product_spec_desc
string

Product specification description.

category_code
string

Product catalog code.

product_owner_service
string

Type code of a cloud service. Cloud service type code.

commercial_resource
string

Type code of a commercial resource. Resource type code.

Status code: 400

CBC.0100:Parameter error.

Example Request
Example 1
"GET https://bss-intl.myhuaweicloud.com/v2/orders/customer-orders/details/CS19040119281JMYC?limit=10&offset=0&indirect_partner_id=c9e731c4663646988ef4cdb3122837b6"
Example Response
Status code: 200

ShowCustomerOrderDetails Responses

Example 1
{
"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
},
"user_name": "h******55",
"pending_payment_end_time": "2020-05-06T08:05:01Z",
"sub_order_infos": []
},
"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
},
"currency": "USD",
"category_code": "hws.resource.storage1.evs",
"product_owner_service": null,
"commercial_resource": null,
"base_product_info": null,
"order_id": "CS18122203217MRPB"
},
{
"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
},
"currency": "USD",
"category_code": "hws.resource.computing.ecs",
"product_owner_service": null,
"commercial_resource": null,
"base_product_info": {
"product_id": "00301-01026-0--1",
"product_spec_desc": "General Computing|s2.medium.4|1vCPUs|2GB|linux",
"category_code": "hws.resource.computing.ecs",
"product_owner_service": null,
"commercial_resource": null
},
"order_id": "CS18122203217MRPB"
}
]
}
SDK
Click Customer Operation Capabilities (BSSINTL) SDK to download the SDK in your programming language or view the SDK documentation. To learn how to install an SDK and perform authentication, read Usage.
Error Code
Change History
Jan 23, 2025
Querying Order Details
GET
   ShowCustomerOrderDetails
Modify
Modified Parameters
Nov 28, 2024
Querying Order Details
GET
   ShowCustomerOrderDetails
Modify
Modified Parameters

Outline

API Description
Constraints
URL
Request Parameters
Response Parameters
Example Request
Example Response
SDK
Error Code
Change History