Last updated: 2019-09-09 14:59:29

1. API Description

API domain name:

This API (DescribeOrders) describes order details.

API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The name of this API: DescribeOrders
Version Yes String Common parameter. The version of this API: 2018-03-28
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
DealNames.N Yes Array of String Order array. The order name will be returned upon shipping, which can be used to call the DescribeOrders API to query shipment status

3. Output Parameters

Parameter name Type Description
Deals Array of DealInfo Order information array
TotalCount Integer Number of orders returned
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Querying Orders

Input Sample Code
&<Common request parameter>

Output Sample Code

  "Response": {
    "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
    "Deals": [
        "DealName": "201806271765",
        "OwnerUin": "3374998458",
        "Count": 1,
        "FlowId": 3456,
        "InstanceIdSet": [

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.QueryOrderFailed Failed to query the order.
InternalError.DBError Database error.
InvalidParameter.InputIllegal Invalid input.
InvalidParameter.ParamsAssertFailed Parameter assertion conversion error.