查询订单列表。

使用限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String ListOrder

系统规定参数。取值:ListOrder

OrderId String 21450******0275

订单ID。

StartDate String 2022-04-05

订单购买的时间区间(开始日期)。

格式:YYYY-MM-dd

EndDate String 2022-04-05

订单购买的时间区间(结束日期)。

格式:YYYY-MM-dd

OrderType String NEW

订单类型。

  • NEW:新购。
  • ADD_FLOW:扩池。
  • ADD_CARD:补卡。
  • FUNCTION:购月功能费。
  • FLOW_PLUS:购买叠加包。
  • RENEW:续订套餐。
  • AUTO_RENEW:自动续订套餐。
OrderStatus String processing

订单状态。

  • processing:处理中。
  • failure:失败。
  • completed:处理完成。
  • unpaid:待支付。
  • refunded:已退款。
PageNo Integer 1

查询页数,需结合PageSize参数使用。

PageSize Integer 10

每页的数量,支持10、15、25、40。

CredentialNo String CT-SF-M-2-100M

套餐凭证。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称

类型

示例值

描述

Code String 200

接口返回码。

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
ErrorMessage String InstanceId cannot be empty.

调用失败时,返回的错误信息。

RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

请求ID,阿里云为该请求生成的标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。
LocalizedMessage String InstanceId cannot be empty.

根据当前所在地展示对应语言的错误提示。

Data Object

返回信息。

PageNo Integer 1

查询页数。

PageSize Integer 10

每页的数量。

PageCount Integer 5

总页数。

Total Integer 48

符合条件的总订单数。

List Array of OrderListVO

订单列表。

BillingCycle String 1101

套餐结算周期。

  • 1101:月度。
  • 1103:季度。
  • 1106:半年度。
  • 1112:年度。
BuyNum Integer 100

购买张数。

PoolCapacityUnit String GB

池容量单位。

CardPayCount Integer 2022-04-11 16:43:00

支付时间。

CredentialPackage String AL-UPG-******3_beika4

套餐凭证。

Vendor String CMCC

运营商。

  • CMCC:移动。
  • CUCC:联通。
  • CTCC:电信。
  • VNO:虚拟运营商。
DataLevel String 30MB

流量包档位。

PayDuration String 12月

购买时长。

AliFee String ali_2

资费版本。

OrderStatus String processing

订单状态。

  • processing:处理中。
  • failure:失败。
  • completed:处理完成。
  • unpaid:待支付。
  • refunded:已退款。
PoolNo String beika4

池编号。

FunctionFee Integer 90

月功能费份数(统付池专用)。

PayTime String 2022-04-11 16:43:00

购买时间。

FlowType String singlecard

流量类型。

  • singlecard:单卡通用流量。
  • directionalcard:单卡定向流量。
  • sameflowcard:同档位池共享流量。
  • directional_sameflowcard:同档位池共享定向流量。
  • unityPayPool:统付池通用流量。
  • GREcard:统付池定向流量。
PoolCapacity String 200

池容量,单位参见PoolCapacityUnit字段。

OrderInfo String 123123

订单信息。

OrderType String NEW

订单类型。

  • NEW:新购。
  • ADD_FLOW:扩池。
  • ADD_CARD:补卡。
  • FUNCTION:购月功能费。
  • FLOW_PLUS:购买叠加包。
  • RENEW:续订套餐。
  • AUTO_RENEW:自动续订套餐。
OrderId String 21450******0275

订单编号。

CredentialNo String CM-***-*-2-**M

套餐凭证。

ExpressNoList Array of String 123123123

物流单号。

DeliveryInfo Object

收货信息。

ZipCode String 100000

收货信息:邮编。

Address String 收货地址

收货信息:地址。

Mail String xxx@xxx.com

收货信息:邮箱。

Receiver String 收件人

收货信息:收件人。

BuyerMessage String 收件电话

收货信息:收件电话。

OrderDetailUrl String https://us******60589

订单详情链接。

ApnName String CMIOTCZHZA.JS

APN名称。

ApnRegion String cn-hangzhou

APN地域。

ResourceQuantity Long 10000

IP购买数量。

NetworkType String 4G

网络制式:4G,5G。

示例

请求示例

http(s)://linkcard.aliyuncs.com/?Action=ListOrder
&OrderId=21450******0275
&StartDate=2022-04-05
&EndDate=2022-04-05
&OrderType=NEW
&OrderStatus=processing
&PageNo=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListOrderResponse>
    <Code>200</Code>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Success>true</Success>
    <Data>
        <PageNo>1</PageNo>
        <PageSize>10</PageSize>
        <PageCount>5</PageCount>
        <Total>48</Total>
        <List>
            <BillingCycle>1101</BillingCycle>
            <BuyNum>100</BuyNum>
            <PoolCapacityUnit>GB</PoolCapacityUnit>
            <CredentialPackage>AL-UPG-******3_beika4</CredentialPackage>
            <Vendor>CMCC</Vendor>
            <DataLevel>30MB</DataLevel>
            <PayDuration>12月</PayDuration>
            <AliFee>ali_2</AliFee>
            <OrderStatus>processing</OrderStatus>
            <PoolNo>beika4</PoolNo>
            <FunctionFee>90</FunctionFee>
            <PayTime>2022-04-11 16:43:00</PayTime>
            <FlowType>singlecard</FlowType>
            <PoolCapacity>200</PoolCapacity>
            <OrderInfo>123123</OrderInfo>
            <OrderType>NEW</OrderType>
            <OrderId>21450******0275</OrderId>
            <CredentialNo>CM-***-*-2-**M</CredentialNo>
            <ExpressNoList>123123123</ExpressNoList>
            <DeliveryInfo>
                <ZipCode>100000</ZipCode>
                <Address>收货地址</Address>
                <Mail>xxx@xxx.com</Mail>
                <Receiver>收件人</Receiver>
                <BuyerMessage>收件电话</BuyerMessage>
            </DeliveryInfo>
            <OrderDetailUrl>https://us******60589</OrderDetailUrl>
        </List>
    </Data>
</ListOrderResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "200",
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Success" : true,
  "Data" : {
    "PageNo" : 1,
    "PageSize" : 10,
    "PageCount" : 5,
    "Total" : 48,
    "List" : [ {
      "BillingCycle" : "1101",
      "BuyNum" : 100,
      "PoolCapacityUnit" : "GB",
      "CredentialPackage" : "AL-UPG-******3_beika4",
      "Vendor" : "CMCC",
      "DataLevel" : "30MB",
      "PayDuration" : "12月",
      "AliFee" : "ali_2",
      "OrderStatus" : "processing",
      "PoolNo" : "beika4",
      "FunctionFee" : 90,
      "PayTime" : "2022-04-11 16:43:00",
      "FlowType" : "singlecard",
      "PoolCapacity" : "200",
      "OrderInfo" : "123123",
      "OrderType" : "NEW",
      "OrderId" : "21450******0275",
      "CredentialNo" : "CM-***-*-2-**M",
      "ExpressNoList" : [ "123123123" ],
      "DeliveryInfo" : {
        "ZipCode" : "100000",
        "Address" : "收货地址",
        "Mail" : "xxx@xxx.com",
        "Receiver" : "收件人",
        "BuyerMessage" : "收件电话"
      },
      "OrderDetailUrl" : "https://us******60589"
    } ]
  }
}