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

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

查询订单详情

功能介绍

客户可以在客户自建平台查看订单详情。

客户登录费用中心查看订单详情请单击这里

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

接口约束

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

调试

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

URI

GET /v2/orders/customer-orders/details/{order_id}

参数说明请参见下表。

表1 路径参数

参数

是否必选

取值范围

描述

order_id

最大长度:64

订单ID。

查询订单列表时系统会返回订单ID。

表2 查询参数

参数

是否必选

取值范围

描述

offset

[0-最大整数]

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

说明:

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

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

limit

[1-100]

每页大小。默认值为10。

表3 消息头参数

参数

是否必选

参数类型

取值范围

描述

X-Language

String

最大长度:10

语言。

en_US:英文

zh_CN:中文

不输入的话,默认为中文

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/orders/customer-orders/details/CS19040119281JMYC?limit=10&offset=0 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。

具体请参见状态码

error_msg

String

最大长度:2000

错误描述信息。

order_info

CustomerOrderEntityV2 Object

-

订单详单。

具体请参见表4

total_count

Integer

-

订单项个数。

order_line_items

List<OrderLineItemEntityV2>

-

订单对应的订单项。

具体请参见表5

表4 CustomerOrderEntityV2

参数

参数类型

取值范围

描述

order_id

String

最大长度:64

订单ID。

customer_id

String

最大长度:64

客户账号ID。

service_type_code

String

-

云服务类型编码,例如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。

amount_info

AmountInfoV2 Object

-

订单扣费详情。

具体请参见表6

currency

String

最大长度:4

货币编码。

contract_id

String

最大长度:64

合同ID。

user_name

String

最大长度:64

订单创建者名称。

  • 如果是客户自己下单,则此处返回下单操作员的登录名称;
  • 如果是运营人员从后台下单,则此处返回“运营人员”;
  • 如果是运营系统自动触发下单,则此处返回“运营系统”。
表5 OrderLineItemEntityV2

参数

参数类型

取值范围

描述

order_line_item_id

String

最大长度:64

订单项ID。

service_type_code

String

最大长度:64

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

product_id

String

最大长度:64

产品ID。

product_spec_desc

String

最大长度:512

产品规格描述。

period_type

Integer

-

周期类型。

  • 0:天
  • 1:周
  • 2:月
  • 3:年
  • 4:小时
  • 5:一次性
  • 6:按需(预留)
  • 7:按用量报表使用(预留)

period_num

Integer

-

周期数量。

说明:

当订单为退订资源的订单时,参数取值为null。

effective_time

String

最大长度:20

生效时间。

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

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

expire_time

String

最大长度:20

失效时间。

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

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

subscription_num

Integer

-

订购数量。

amount_after_discount

Double

-

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

official_amount

Double

-

订单金额(官网价)。

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

amount_info

AmountInfoV2 Object

-

订单扣费详情。

具体请参见表6

currency

String

最大长度:4

货币编码。

category_code

String

最大长度:64

产品目录编码。

product_owner_service

String

最大长度:64

产品归属的云服务类型编码。

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

commercial_resource

string

最大长度:64

商务归属的资源类型编码。

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

表6 AmountInfoV2

参数

参数类型

取值范围

描述

discounts

List<DiscountItemV2>

-

费用项。

具体请参见表7

flexipurchase_coupon_amount

Double

-

现金券金额。

coupon_amount

Double

-

代金券金额。

stored_card_amount

Double

-

储值卡金额。

commission_amount

Double

-

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

consumed_amount

Double

-

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

表7 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": 2,
    "order_info": {
        "order_id": "CS18122203217MRPB",
        "customer_id": "982f05775ec94da390c3f174b058fb46",
        "service_type_code": "hws.service.type.ec2",
        "source_type": 1,
        "status": 5,
        "order_type": 4,
        "amount_after_discount": -277.92,
        "official_amount": -277.92,
        "measure_id": 1,
        "create_time": "2018-12-21T19:21:03Z",
        "payment_time": null,
        "currency": "CNY",
        "contract_id": null,
        "amount_info": {
            "discounts": [],
            "flexipurchase_coupon_amount": null,
            "coupon_amount": null,
            "stored_card_amount": null,
            "commission_amount": 30.88,
            "consumed_amount": 0.0
        },
        "user_name": "h******55"
    },
    "order_line_items": [
        {
            "order_line_item_id": "CS18122203217MRPB-000001",
            "service_type_code": "hws.service.type.ebs",
            "product_id": "00301-01026-0--1",
            "product_spec_desc": "普通IO|40.0GB",
            "period_type": 3,
            "period_num": null,
            "effective_time": "2018-12-21T19:21:03Z",
            "expire_time": "2019-12-22T15:59:59Z",
            "subscription_num": 1,
            "amount_after_discount": -33.12,
            "official_amount": -33.12,
            "amount_info": {
                "discounts": [],
                "flexipurchase_coupon_amount": null,
                "coupon_amount": null,
                "stored_card_amount": null,
                "commission_amount": 3.68,
                "consumed_amount": 0.0
            },
            "currency": "CNY",
            "category_code": "hws.resource.storage1.evs",
            "product_owner_service": null,
            "commercial_resource": null
        },
        {
            "order_line_item_id": "CS18122203217MRPB-000002",
            "service_type_code": "hws.service.type.ec2",
            "product_id": "00301-02019-0--1",
            "product_spec_desc": "通用计算型|s2.medium.4|1vCPUs|4GB|linux",
            "period_type": 3,
            "period_num": null,
            "effective_time": "2018-12-21T19:21:03Z",
            "expire_time": "2019-12-22T15:59:59Z",
            "subscription_num": 1,
            "amount_after_discount": -244.8,
            "official_amount": -244.8,
            "amount_info": {
                "discounts": [],
                "flexipurchase_coupon_amount": null,
                "coupon_amount": null,
                "stored_card_amount": null,
                "commission_amount": 27.2,
                "consumed_amount": 0.0
            },
            "currency": "CNY",
            "category_code": "hws.resource.computing.ecs",
            "product_owner_service": null,
            "commercial_resource": null
        }
    ]
}

状态码

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

400

CBC.0101

参数无效。

403

CBC.0151

访问拒绝。

403

CBC.0155

不允许执行当前请求。

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

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品