Order List
Request Interface
Request Headers
Field Name Field Value Action
+ Add Field
Request Parameters (Params)
Field Name Field Value Action
+ Add Field

* Token can be used in either Request Headers or Request Parameters (Params)

Response Data
{ "status": true, "code": 0, "msg": "获取成功", "data": { "page": 1, "total": 9, "totalPage": 1, "results": [ { "sn": "544987000", "member": 18, "payFrom": "balance", "status": "payed", "currency": "USD", "addtime": 20260305162723, "totalAmount": 6.5, "categoryId": 31, "activationStatus": "activating", "voucherInfo": [], "refund": null }, { "sn": "540538000", "member": 18, "payFrom": "balance", "status": "payed", "currency": "USD", "addtime": 20260210170728, "totalAmount": 6.5, "categoryId": 31, "activationStatus": "activated", "voucherInfo": [ { "orderSn": "540538000", "categoryId": 31, "lpa": "LPA:1$xxx.prod.xxxxxxxxxxx.com$TEST1234567890", "iccid": "89852070322460401234", "status": 2, "number": "", "verifyCode": "123456", "qrcode": "data:image/png;base64,..." } ], "refund": { "status": 2, "applyTime": 20260211101530, "handleTime": 20260211113000, "amount": 6.5, "flowId": "f992069600" } }, ... ] } }
Request Field Descriptions
Field Type Description
token string

Access token/signaling used for API authentication

page number

Order page number (pagination up to the 100000th record)

pageSize number

Page size (default 100, max 200)

status string

Order Status (Optional), values: payed - Paid, pending - Pending, closed - Closed, refuse - Refused, refund - Refunded

Response Field Descriptions
Field Type Description
status boolean

【Request Status】

true - Success

false - Request Failed

code number

【Status Code】

0 - Retrieved successfully

4004 - Invalid parameter

4003 - Token Has No Corresponding User

4009 - Current IP is not in the whitelist

4013 - Requests too frequent, please try again later (each member defaults to 180 requests/minute)

40111 - Account Not Verified, API Access Not Allowed

msg string

【Request Description】

data array

page - Current Page Number

total - Total Orders

totalPage - Total Pages

results - Order List


【Order Details】

sn - Order Number

status - Order Status (Optional), values: payed - Paid, pending - Pending, closed - Closed, refuse - Refused, refund - Refunded

addtime - Order creation time (UTC+8 standard time, YmdHis)

member - User ID

payFrom - Payment Source

currency - Currency Type

totalAmount - Order Amount

categoryId - Product (category) ID, which can be used to call the product detail API for lookup

activationStatus - eSIM Activation Status (activated - activated, activating - activating)

voucherInfo - eSIM Voucher Information (empty array when activationStatus is activating; an array when activated, where each element represents an eSIM card)


【eSIM Voucher Information】(When voucherInfo is not empty, each element contains the following fields)

orderSn - Order Number

categoryId - eSIM Type ID

lpa - eSIM Configuration (Used to generate QR code)

iccid - eSIM Card ICCID

status - Voucher Status (2 - Claimed)

number - eSIM Card Number

verifyCode - eSIM Configuration Authentication Code

qrcode - eSIM Configuration QR Code (base64 format)


refund - Refund result (null when no refund has occurred; an object once a refund has been initiated, fields below)


【Refund result (when refund is not null, it contains the following fields)】

status - Refund status: 1 - refund requested, 2 - approved and refunded, 3 - refused

applyTime - Refund application time (YmdHis, UTC+8 standard time, 0 means none)

handleTime - Refund handling time (YmdHis, UTC+8 standard time, 0 means not processed)

amount - Actual refund amount (retrieved from fund flows; 0 when not yet credited)

flowId - Refund flow number (the unique identifier of a refund fund flow, string type; an empty string when no refund flow has been generated)