客户运营能力客户运营能力

更新时间:2021/06/29 GMT+08:00
分享

查询订单列表

功能介绍

客户购买包年/包月资源后,可以查看待审核、处理中、已取消、已完成和待支付等状态的订单。

客户登录费用中心进入“我的订单”页面,选择“全部”页签,可以查看待审核、处理中、已取消、已完成和待支付等状态的订单。

如果想查询某条订单下的资源信息,在调用本接口获取订单ID后,请调用“查询客户包年/包月资源列表”接口在请求参数输入订单号进行查询。

接口约束

该接口可以使用客户AK/SK或者Token调用。

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v2/orders/customer-orders
表1 查询参数

参数

是否必选

参数类型

取值范围

描述

order_id

String

最大长度:64

订单ID。

说明:

使用特殊字符进行查询的时候,请注意进行URL编码转换,如“%”的转码应为“%25”。

customer_id

String

最大长度:64

客户账号ID。

create_time_begin

String

最大长度:20

订单创建开始时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

create_time_end

String

最大长度:20

订单创建结束时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

service_type_code

String

最大长度:64

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。您可以调用查询云服务类型列表接口获取。

status

Integer

-

订单状态。

  • 1:待审核
  • 3:处理中
  • 4:已取消
  • 5:已完成
  • 6:待支付
  • 9:待确认

order_type

String

最大长度:64

订单类型。

  • 1:开通
  • 2:续订
  • 3:变更
  • 4:退订
  • 11:按需转包年/包月
  • 13:试用
  • 14:转商用
  • 15:费用调整

limit

Integer

[1-100]

每次查询的订单数量,默认值为10。

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

order_by

String

最大长度:36

查询的订单列表排序。

支持按照创建时间进行排序,带-表示倒序。

创建时间:升序为createTime,倒序为-createTime。

payment_time_begin

String

最大长度:20

订单支付开始时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

payment_time_end

String

最大长度:20

订单支付结束时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/orders/customer-orders?order_id=CS1905251035OA1AF&customer_id=c9e731c4663646988ef4cdb3122837b6&create_time_begin=2020-05-06T08:05:01Z&create_time_end=2020-05-07T08:05:01Z&service_type_code=hws.service.type.ec2&status=5&order_type=1&limit=10&offset=0&order_by=-2BcreateTime&payment_time_begin=2020-05-06T08:05:01Z&payment_time_end=2020-05-07T08:05:01Z HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。

具体请参见状态码

error_msg

String

最大长度:2000

错误描述信息。

total_count

Integer

大于等于0的整数

大于等于0的整数。

符合条件的记录总数。

order_infos

List<CustomerOrderV2>

-

-

客户订单详情信息。

具体请参见表2

表2 CustomerOrderV2

参数

参数类型

取值范围

描述

order_id

String

最大长度:64

订单ID。

customer_id

String

最大长度:64

客户账号ID。

service_type_code

String

最大长度:64

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。您可以调用查询云服务类型列表接口获取。

source_type

Integer

-

客户订单订单来源类型:

  • 1:客户
  • 2:代理
  • 3:合同
  • 4:分销商

status

Integer

-

订单状态:

  • 1:待审核
  • 3:处理中
  • 4:已取消
  • 5:已完成
  • 6:待支付
  • 9:待确认

order_type

Integer

-

订单类型:

  • 1:开通
  • 2:续订
  • 3:变更
  • 4:退订
  • 11:按需转包年/包月
  • 13:试用
  • 14:转商用
  • 15:费用调整

official_amount

Double

-

订单金额(官网价)。

退订订单中,该金额等于amount_after_discount。

amount_after_discount

Double

-

订单优惠后金额(不含券不含卡的实付价格)。

measure_id

Integer

-

订单金额度量单位:

  • 1:元

create_time

String

最大长度:20

创建时间 。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

payment_time

String

最大长度:20

支付时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

其中,HH范围是0~23,mm和ss范围是0~59。

currency

String

最大长度:4

货币编码。

contract_id

String

最大长度:64

合同ID。

amount_info

AmountInfoV2 Object

-

订单扣费详情。

具体请参见表3

表3 AmountInfoV2

参数

参数类型

取值范围

描述

discounts

List<DiscountItemV2>

-

费用项。

具体请参见表4

flexipurchase_coupon_amount

Double

-

现金券金额。

coupon_amount

Double

-

代金券金额。

stored_card_amount

Double

-

储值卡金额。

commission_amount

Double

-

手续费(仅退订订单存在)。

consumed_amount

Double

-

消费金额(仅退订订单存在)。

表4 DiscountItemV2

参数

参数类型

取值范围

描述

discount_type

String

最大长度:8

折扣类型:

  • 200:促销产品折扣
  • 300:促销折扣券
  • 301:促销代金券
  • 302:促销现金券
  • 500:代理订购指定折扣
  • 501:代理订购指定减免
  • 502:代理订购指定一口价
  • 600:折扣返利合同
  • 601:渠道框架合同
  • 602:专款专用合同
  • 603:线下直签合同
  • 604:电销授权合同
  • 605:商务合同折扣
  • 606:渠道商务合同折扣
  • 607:合作伙伴授权折扣
  • 609:订单调价折扣
  • 610:免单金额
  • 700:促销折扣
  • 800:充值帐户折扣
  • 900:产品本身折扣
  • 901:基准价一口价的折扣

discount_amount

Double

-

折扣金额。

响应示例:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 1,
    "order_infos": [
        {
            "order_id": "CS1905251035OA1AF",
            "customer_id": "17a80a9f9d3949ddb60ee73a5b3c9618",
            "service_type_code": "hws.service.type.rds",
            "source_type": 1,
            "status": 5,
            "order_type": 1,
            "amount_after_discount": 0,
            "official_amount": 100,
            "measure_id": 1,
            "create_time": "2020-05-06T09:08:03Z",
            "payment_time": "2020-05-06T09:08:03Z",
            "currency": "CNY",
            "contract_id": null,
            "amount_info": {
                "discounts": [
                    {
                        "discount_type": "700",
                        "discount_amount": 15
                    },
                    {
                        "discount_type": "302",
                        "discount_amount": 85
                    }
                ],
                "flexipurchase_coupon_amount": 85,
                "coupon_amount": 0,
                "stored_card_amount": 0,
                "commission_amount": null,
                "consumed_amount": null
            }
        } ]
}

状态码

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

400

CBC.0101

参数无效。

403

CBC.0151

访问拒绝。

403

CBC.0155

不允许执行当前请求。

原因可能为账号鉴权信息不正确、账号或子账号没有接口调用权限。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品