Menu

Order List

Usage Instructions

Get Team Order List with pagination support. Maximum 500 items per page.

Request Instructions

  • Method: POST
  • Endpoint: /api/v1/team/order

Request Parameters

Parameter Type Required Description
created_at_start string Yes Order creation start time. Must be a date and time string that is the same as or earlier than created_at_end, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM), for example: 2026-03-16T00:00:00+08:00. If not provided, the default is the last 7 days (GMT+08:00).
created_at_end string Yes Order creation end time. Must be a date and time string that is the same as or later than created_at_start, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM), for example: 2026-03-16T00:00:00+08:00. If not provided, the default is the last 7 days (GMT+08:00).
image_ids array No Cloud phone IDs
order_id string No Order No
status array No Status: 1 for Unpaid; 2 for Cancelled; 3 for Paid; 4 for Failed; 5 for Finished; 6 for Expired; 7 for Refunded
type array No Order type: 1 for Purchase; 2 for Renewal; 3 for Recharge; 4 for Deduction; 5 for Redeem; 6 for Gift; 7 for Refund; 8 for Transfer; 9 for Receive
product_type array No Product type: 1 for Subscription Startup; 2 for Cloud Phone; 3 for Balance; 4 for Gift; 5 for Reset Device Times; 6 for Temporary Startup; 7 for Change Cloud Drive Plan; 8 for Renew Cloud Drive Plan; 9 for Technical Service Fee; 10 for Cloud Number; 11 for AI Credits
sort_by string No Sort field. Supported: created_at (Creation time); total (Amount)
order string No Sort order. asc for Ascending; desc for Descending
page int No Page number for the request. If not provided, defaults to the first page
pagesize int No Number of items per page. If not provided, defaults to 10 items/page. The currently supported maximum is 500

Request Example

json Copy
{
    "page": 1,
    "pagesize": 200,
    "image_ids": [
        "xxx",
        "xxx"
    ],
    "type": [
        "2",
        "3"
    ],
    "product_type": [
        "2"
    ],
    "status": [
        "1",
        "2"
    ],
    "created_at_start": "2026-02-10T00:00:00+08:00",
    "created_at_end": "2026-03-18T23:59:59+08:00",
    "order_id": "xxxx",
    "sort_by": "created_at",
    "order": "asc"
}

Response Example

json Copy
{
    "code": 200,
    "data": {
        "list": [
            {
                "type": "Renewal",                    // Type
                "order_id": "xxxx",                   // Order No
                "product": "Cloud phone",             // Product 
                "description": "xxxx",                // Description
                "status": "Unpaid",                   // Status
                "total": "-$21.91",                   // Amount
                "created_at": "2026-02-12T11:34:55+08:00",  // Creation time
                "expired_at": "2026-02-12T12:04:55+08:00",  // Expiry time. Empty when the order is not in the "Unpaid" status.
                "expired_seconds": 1795               // Remaining seconds until the pending payment order expires.
            },
            {
                "type": "Purchase",
                "order_id": "xxxx",
                "product": "Cloud phone", 
                "description": "xxxx", 
                "status": "Finished",
                "total": "-$0.80", 
                "created_at": "2026-02-13T14:09:55+08:00",
                "expired_at": "",
                "expired_seconds": 0 
            },
            {
                "type": "Purchase",
                "order_id": "xxx",
                "product": "云手机",
                "description": "",
                "status": "Cancelled",
                "total": "-$21.91",
                "created_at": "2026-03-10T16:49:55+08:00",
                "expired_at": "",
                "expired_seconds": 0
            },
        ],
        "page": 1,
        "pagesize": 200,
        "total": 3,
        "total_page": 1
    },
    "message": "Success"
}
Previous
Team
Next
How to develop plug-in modules
Last modified: 2026-03-18Powered by