Get Order Details

Get the detailed information of a specific order.

Request URL

GET {base_url}/order/openapi/order/v1/get/{id}

Request parameters

Path parameter
Parameter Required Type Description
id Yes Long The order number or the unique ID of the order.
Note: You can query order number and order ID using the Query Order List interface. Order number can also be obtained from Partner Portal (Path: Orders & Billing > Orders > Order No.)
Headers
Parameter Required Description
User-Agent Yes Provide information about the user agent, such as the type of web browser, operating system, software version, etc., so as to help Yeastar Partner Portal to identify the user or the application that is making the request.

Example: User-Agent: OpenAPI.
Authorization Yes Pass the access token in the header, so as to authenticate the API request.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
code String The response message of the API request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
requestId String The unique ID of the request, which can be used to quickly locate the request.
result Object<Details> The information list of the order.
status Integer The HTTP status code of the API request.

Details

Parameter Type Description
basicInformation Object<Basic_Info> Basic information of the order.
billingInformation Object<Billing_Info> Information of the billing contact.
orderInformation Object<Order_Info> Detailed information of the order.
orderSummary Object<Order_Sum> Detailed information of plan or service(s) in the order.
Basic_Info
Parameter Type Description
productId String The unique ID of the product.
  • 9: Linkus Cloud Service.
  • 11: P-Series Plan for Appliance Edition.
  • 12: Software PBX (PSE Self-hosted).
  • 13: Cloud PBX (PCE Instance).
productName String Product name.
productNo String The unique product identifier.

This parameter returns the Serial Number (SN) of the PBX.
Billing_Info
Parameter Type Description
city String City.
company String Company.
contactEmail String Email address.

The invoice is sent to this email address after successful payment.
country String Country.
firstName String First name.
lastName String Last name.
phoneNumber String Phone number.
province String Province.
remark String Remark.
street String Street.
taxNum String Tax identification number.
zipCode String ZIP / postal code.
Order_Info
Parameter Type Description
createTime Long Creation time of the order.
id String The unique ID of the order.
orderNo String Order number.
Order_Sum
Parameter Type Description
currencyCode String Currency for payment.
  • USD
  • RMB
orderDetailList Array<Order_Details> The detailed information of the plan or service(s) in the order.
totalPrice Number The total of the actual price.
Order_Details
Parameter Type Description
billingCycle String Billing cycle.
  • annually
  • monthly
expireTime Long Expiration date of the plan or service.
intervalUnit String The time unit of the subscription.
  • year
  • month
price number The actual price of the plan or service.
quantity Integer The quantity of the purchased item in the plan or service.
serviceName String The name of the plan or service.
servicePeriod Integer Validity period of the plan or service.
Note: This parameter is returned only for P-Series Software Edition.

Example

Request example

Query the detailed information of an order (ID: 1072861).

GET /order/openapi/order/v1/get/1072861 HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTEzNjQ0ODkwODMyODk2XCIsXCJ1c2VyQ29kZVwiOlwiRGlzdHJpYnV0b3JcIixcInVzZXJJZFwiOlwiMzA3NjkxMzY0NDkxNTk5ODcyMFwiLFwidXNlcm5hbWVcIjpcImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbVwifSIsInVzZXJfbmFtZSI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3MzkyODEzMTYsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoiZ29FQ3BpSkMzMXlOQ2tkcktQSWVvaFE1dEtZPSIsImF1dGhvcml0aWVzIjpbIjc3Il0sImNsaWVudF9pZCI6ImFjMGYyZTViZWU3NmI2ZDdmNDU0NTY5NmMyNGZjMWYzIn0.O2ubDUQIqZsMguPt9adKWD-pwCvS_2e5VMMTWIQCO4c

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "1b28ec19194bd302b7aceea8af7b9b39",
    "result": {
        "basicInformation": {
            "productId": "12",
            "productName": "Software PBX (PSE Self-hosted)",
            "productNo": "3651D4230827"
        },
        "billingInformation": {
            "city": "Xiamen",
            "company": "Company Example",
            "contactEmail": "example@outlook.com",
            "country": "Italy",
            "firstName": "Example",
            "lastName": "Li",
            "phoneNumber": "13600930000",
            "province": "Fujian",
            "remark": "",
            "street": "Siming",
            "taxNum": "VAT_number:",
            "zipCode": "361000"
        },
        "orderInformation": {
            "createTime": 1697620687000,
            "id": "1072861",
            "orderNo": "YX3149774189474799616"
        },
        "orderSummary": {
            "currencyCode": "USD",
            "orderDetailList": [
                {
                    "billingCycle": "annually",
                    "expireTime": 1729156682000,
                    "intervalUnit": "year",
                    "price": 242.33,
                    "quantity": 100,
                    "serviceName": "Enterprise Plan"
                },
                {
                    "billingCycle": "annually",
                    "expireTime": 1729156682000,
                    "intervalUnit": "year",
                    "price": 243.00,
                    "quantity": null,
                    "serviceName": "PMS",
                    "servicePeriod": null
                }
            ],
            "totalPrice": 485.33
        }
    },
    "status": 200
}