API Name
GetOrderDetail
Overview
You can call this operation to query the details of a specified order.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
| OrderId | String | Yes | The ID of the specified order. If OwnerId has been specified, OrderId is set to the ID of the order from a distributer’s customer. |
Response parameters
| Name | Type | Description |
|---|---|---|
| OrderID | String | The ID of the specified order. |
| ProductCode | String | The code of the specified main product. |
| ProductType | String | The type of the specified main product. |
| SubscriptionType | String | The type of billing method. Valid values: Subscription and PayAsYouGo. |
| OrderType | String | The type of order. Valid values: New, Renew, Upgrade, Refund |
| CreateTime | String | The time when the specified order was created. |
| PaymentTime | String | The time of payment. |
| PaymentStatus | String | The status of payment. Valid values: Unpaid, Paid, Cancelled |
| Region | String | The region that the specified instance is located in. |
| Config | String | The configuration of the specified main product. |
| Quantity | Integer | The quantity of the specified main product. |
| UsageStartTime | String | The time when the specified service starts. |
| UsageEndTime | String | The time when the specified service ends. |
| InstanceIDs | String | The list of instance identifiers. |
| PretaxGrossAmount | String | The pretax gross amount. |
| PretaxAmount | String | The pretax amount. |
| Currency | String | The type of currency. |
Error codes
| Error code | Description | HTTP status code | Description |
|---|---|---|---|
| NotApplicable | This API is not applicable for caller. | 400 | The error message returned when you are not authorized to use the API. |
| MissingParameter | The specified parameter xx is mandatory for this request. | 400 | The error message returned when the xx parameter is not specified. |
| InvalidParameter | The specified parameter xx is not valid. | 400 | The error message returned when the xx parameter is invalid. |
| InvalidModuleCode | The specified moduleCode is not valid. | 400 | The error message returned when the specified moduleCode parameter is invalid. |
| InvalidConfigCode | The specified configCode is not valid. | 400 | The error message returned when the specified configCode parameter is invalid. |
| InvalidOwner | The specified owner doesn’t belong to caller. | 400 | The error message returned when the specified owner does not belong to the caller. |
| InvalidCaller | The specified caller doesn’t exists. | 400 | The error message returned when the caller is invalid. |
| InternalError | The request processing has failed due to some unknown error, exception or failure. | 400 | The error message returned when an unknown internal error occurs. |
| ProductNotFind | Can not find inquired product, it may not exist. | 400 | The error message returned when the specified product is invalid. |
Sample requests
https://business.ap-southeast-1.aliyuncs.com/?Action=GetOrderDetail&OrderId=500491030350914
Sample responses
"Data": {"OrderList": {"Order": [{"Config": "","SubscriptionType": "Subscription","Quantity": 1,"PretaxAmountLocal": 0.11,"OrderId": "500491030350914","SubOrderId": "500491030350914","AfterTaxAmount": 0.12,"Tax": 0.01,"PretaxAmount": 0.11,"PaymentStatus": "Cancelled","UsageStartTime": "2018-09-17T06:13:42Z","UsageEndTime": "2018-09-18T16:00:00Z","PaymentTime": "2018-09-17T06:13:43Z","PaymentCurrency": "USD","ProductType": "","OrderType": "New","CreateTime": "2018-09-17T06:13:43Z","Currency": "USD","PretaxGrossAmount": 0.1}]}
Data dictionary
None.