查询订单详情-九游平台

功能介绍

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

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

如果想查询某条订单下的资源信息，请调用“”接口在请求参数输入订单号进行查询。

接口约束

该接口可以使用客户ak/sk或者token调用。

调试

您可以在中调试该接口。

uri

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

参数说明请参见下表。

表1 路径参数
参数	是否必选	取值范围	描述
order_id	是	最大长度：64	订单id。查询订单列表时系统会返回订单id。

表2 查询参数
参数	是否必选	取值范围	描述
offset	否	[0-最大整数]	偏移量，从0开始。默认值为0。此参数不携带或携带值为空或携带值为null，取默认值0。说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。示例1，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写10。
limit	否	[1-100]	每页大小。默认值为10。此参数不携带或携带值为空或携带值为null，取默认值10。

表3 消息头参数
参数	是否必选	参数类型	取值范围	描述
x-language	否	string	最大长度：10	语言。 zh_cn：中文 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-token：miipagyjkozihvcnaqcco...ggg1bbiinpxsidg9rz

响应消息

响应参数

参数	参数类型	取值范围	描述
error_code	string	最大长度：20	状态码。具体请参见状态码。
error_msg	string	最大长度：2000	错误描述信息。
order_info	customerorderentityv2 object	-	订单详单。具体请参见表4。
total_count	integer	-	订单项个数。
order_line_items	list	-	订单对应的订单项。具体请参见表5。

表4 customerorderentityv2
参数	参数类型	取值范围	描述
order_id	string	最大长度：64	订单id。
customer_id	string	最大长度：64	客户账号id。
service_type_code	string	-	云服务类型编码。例如obs的云服务类型编码为“hws.service.type.obs”。
service_type_name	string	最大长度：200	云服务类型名称。例如ecs的云服务类型名称为“弹性云服务器”。
source_type	integer	-	客户订单来源类型： 1：客户 2：代理 3：合同 4：分销商
status	integer	-	订单状态。 1：待审核 2：待退款 3：处理中 4：已取消 5：已完成 6：待付款 9：待确认 10：待发货 11：待收货 12：待上门取货 13：换新中
order_type	integer	-	订单类型。 1：开通 2：续订 3：变更 4：退订 10：包年/包月转按需 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	-	订单扣费详情。具体请参见表7。
currency	string	最大长度：4	货币编码。
contract_id	string	最大长度：64	合同id。
user_name	string	最大长度：64	订单创建者名称。如果是客户自己下单，则此处返回下单操作员的登录名称；如果是运营人员从后台下单，则此处返回“运营人员”；如果是运营系统自动触发下单，则此处返回“运营系统”。
pending_payment_end_time	string	最大长度：20	订单待付款截止时间。 utc时间，格式：yyyy-mm-dd't'hh:mm:ss'z'，如“2019-05-06t08:05:01z”。其中，hh范围是0～23，mm和ss范围是0～59。说明：仅当订单状态为待付款时，参数返回具体值。其他订单状态，参数取值为null。
sub_order_infos	list	-	客户订单下属的订单详情信息。具体请参见表9 说明：当查询订单为组合交易订单时，订单信息会返回下属的订单信息，当查询为普通订单时，此字段返回为空。

表5 orderlineitementityv2
参数	参数类型	取值范围	描述
order_line_item_id	string	最大长度：64	订单项id。
service_type_code	string	最大长度：64	云服务类型编码。例如obs的云服务类型编码为“hws.service.type.obs”。
service_type_name	string	最大长度：200	云服务类型名称。例如ecs的云服务类型名称为“弹性云服务器”。
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	-	订单金额（九游平台官网价）。退订订单中，该金额等于amount_after_discount。
amount_info	amountinfov2 object	-	订单扣费详情。具体请参见表7。
currency	string	最大长度：4	货币编码。
category_code	string	最大长度：64	产品目录编码。
product_owner_service	string	最大长度：64	产品归属的云服务类型编码。云服务类型编码，例如obs的云服务类型编码为“hws.service.type.obs”。您可以调用接口获取。
commercial_resource	string	最大长度：64	商务归属的资源类型编码。资源类型编码，例如ecs的vm为“hws.resource.type.vm”。您可以调用接口获取。
base_product_info	baseproductinfo object	--	变更前订单行产品信息。具体请参见表 baseproductinfo。说明：仅当订单类型为变更时，参数返回具体值。其他订单类型，参数取值为null。
order_id	string	最大长度：64	订单id。

表6 baseproductinfo
参数	参数类型	取值范围	描述
product_id	string	最大长度：64	产品id。
product_spec_desc	string	最大长度：512	产品规格描述。
category_code	string	最大长度：64	产品目录编码。
product_owner_service	string	最大长度：64	产品归属的云服务类型编码。云服务类型编码，例如obs的云服务类型编码为“hws.service.type.obs”。您可以调用接口获取。
commercial_resource	string	最大长度：64	商务归属的资源类型编码。资源类型编码，例如ecs的vm为“hws.resource.type.vm”。您可以调用接口获取。

表7 amountinfov2
参数	参数类型	取值范围	描述
discounts	list	-	费用项。具体请参见表8。
flexipurchase_coupon_amount	double	-	现金券金额。
coupon_amount	double	-	代金券金额。
stored_card_amount	double	-	储值卡金额。
commission_amount	double	-	手续费（仅退订订单存在）。
consumed_amount	double	-	消费金额（仅退订订单存在）。

表8 discountitemv2
参数	参数类型	取值范围	描述
discount_type	string	最大长度：8	折扣类型： 200：促销产品折扣 300：促销折扣券 301：促销代金券 302：促销现金券 500：代理订购指定折扣 501：代理订购指定减免 502：代理订购指定一口价 600：折扣返利合同 601：渠道框架合同 602：专款专用合同 603：线下直签合同 604：电销授权合同 605：商务合同折扣 606：渠道商务合同折扣 607：九游平台的合作伙伴授权折扣 609：订单调价折扣 610：免单金额 700：促销折扣 800：充值帐户折扣
discount_amount	double	-	折扣金额。

表9 subcustomerorderentityv2
参数	参数类型	取值范围	描述
order_id	string	最大长度：64	订单id。
customer_id	string	最大长度：64	客户账号id。
service_type_code	string	-	云服务类型编码。例如obs的云服务类型编码为“hws.service.type.obs”。
service_type_name	string	最大长度：200	云服务类型名称。例如ecs的云服务类型名称为“弹性云服务器”。
source_type	integer	-	客户订单来源类型： 1：客户 2：代理 3：合同 4：分销商
status	integer	-	订单状态。 1：待审核 2：待退款 3：处理中 4：已取消 5：已完成 6：待付款 9：待确认 10：待发货 11：待收货 12：待上门取货 13：换新中
order_type	integer	-	订单类型。 1：开通 2：续订 3：变更 4：退订 10：包年/包月转按需 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	-	订单扣费详情。具体请参见表7。
currency	string	最大长度：4	货币编码。
contract_id	string	最大长度：64	合同id。
user_name	string	最大长度：64	订单创建者名称。如果是客户自己下单，则此处返回下单操作员的登录名称；如果是运营人员从后台下单，则此处返回“运营人员”；如果是运营系统自动触发下单，则此处返回“运营系统”。
pending_payment_end_time	string	最大长度：20	订单待付款截止时间。 utc时间，格式：yyyy-mm-dd't'hh:mm:ss'z'，如“2019-05-06t08:05:01z”。其中，hh范围是0～23，mm和ss范围是0～59。说明：仅当订单状态为待付款时，参数返回具体值。其他订单状态，参数取值为null。

响应示例:

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.obs",
        "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",
        "pending_payment_end_time": "2024-11-14t15:59:59z",
        "sub_order_infos": []
    },
    "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,
            "base_product_info": null,
            "order_id": 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,
            "base_product_info": {
                "product_id": "00301-238595-0--0",
                "product_spec_desc": "通用计算型|s3.small.1|1vcpus|1gb|linux",
                "category_code": "hws.resource.computing.ecs",
                "product_owner_service": "hws.service.type.ec2",
                "commercial_resource": null
            },
            "order_id": "s1812**********rpb"
        }
    ]
}

状态码

状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。

http状态码	错误码	描述
400	cbc.0100	参数错误。
400	cbc.0101	参数无效。
400	cbc.30000010	无效订单（可能是订单不存在），不能进行操作。
403	cbc.0155	不允许执行当前请求。原因可能为账号鉴权信息不正确、账号或子账号没有接口调用权限。
500	cbc.0999	其他错误。

查询订单详情-九游平台

功能介绍

接口约束

调试

uri

请求消息

响应消息

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

售前咨询热线