Get order details

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Get the order details of the current user pool

Method name

ManagementClient.getOrderDetail

Request parameters

Name	Type	Is it required	Default value	Description	Sample value
orderNo	string	Yes	-	Order number	2022080410062060e26f7fd6b9

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.getOrderDetail({
    orderNo: "20220804xxxxxx60e26f7fd6b9",
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request Response

Type: CostGetOrderDetailRespDto

Name	Type	Description
statusCode	number	Business status code. This status code can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code. This error code can be used to get the specific error type (successful requests are not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. It will be returned when the request fails.
data	<a OrderItem	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "orderNo": "202209251234224",
    "status": "1: Unpaid, 2: Paid, 3: Completed, 4: Cancelled, 5: Expired",
    "orderType": "New: New purchase, Upgrade: Upgrade, Renew: Renew, Overdue_Correct: Overdue correction, Overflowed_Correct: Overdue correction"
  }
}

Data structure

OrderItem

Name	Type	Is it required?	Description	Sample value
orderNo	string	Yes	Order number	202209251234224
goodsName	string	Yes	Package name in Chinese
goodsNameEn	string	yes	Package name in English
goodsUnitPrice	string	yes	Unit price
quantity	string	yes	Quantity
actualAmount	string	yes	Actual amount
status	string	yes	Order status	1: Unpaid, 2: Paid, 3: Completed, 4: Cancelled, 5: Expired
orderType	string	yes	Order type	New: New purchase, Upgrade: Upgrade, Renew: Renewal, Overdue_Correct: Overdue correction, Overflowed_Correct: Overflowed correction
createTime	string	yes	Creation time
source	string	yes	Licence: License order, Offline: Offline transaction, Eadmin: Backstage activation, SelfHelp: Self-service order, Cdkey: Cdkey activity redemption