# 查询订单列表-ListCustomerOrders #### 功能介绍 客户购买包年/包月资源后，可以查看待审核、处理中、已取消、已完成和待支付等状态的订单。 伙伴登录伙伴中心查看客户订单请单击[这里](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0076200001.html)。 ![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png) 如果想查询某条订单下的资源信息，在调用本接口获取订单ID后，请调用"[查询客户包年/包月资源列表-ListPayPerUseCustomerResources](https://support.huaweicloud.com/api-bpconsole/api_order_00021.html)"接口在请求参数输入订单号进行查询。 #### 接口约束 该接口既可以使用解决方案提供商或华为云总经销商（一级经销商）的AK/SK或者Token调用，也可以使用客户AK/SK或者Token调用。用解决方案提供商或华为云总经销商（一级经销商）自身的AK/SK或者Token调用的情况下，可以查询解决方案提供商或华为云总经销商（一级经销商）所有客户的订单。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListCustomerOrders)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 操作员账号调用当前API需经过授权，您可以通过伙伴中心为操作员赋予相应权限项来完成授权。有关如何为角色授权的详细信息，请参见[为组织人员分配权限](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0072435164.html)。 接口对应的权限项如下： | 权限项 | 权限项名称 | |:---|:---| | BPC_ITEM_SUBCUSTSERV_060100\|BPC_ITEM_SUBCUSTSERV_060200 | - 销售-客户-客户订单-客户订单-查看列表 - 销售-客户-客户订单-二级经销商的客户-查看列表 | #### URI GET /v2/orders/customer-orders 表1查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | order_id | 否 | String | 最大长度：64 | 订单ID。大小写不敏感。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 说明： 使用特殊字符进行查询的时候，请注意进行URL编码转换，如"%"的转码应为"%25"。 | | customer_id | 否 | String | 最大长度：64 | 客户账号ID。您可以调用[查询客户列表-ListSubCustomers](https://support.huaweicloud.com/api-bpconsole/mc_00021.html)接口获取customer_id。 此参数不携带时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空或携带值为空串。 | | 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。 订单创建开始时间与订单创建结束时间间隔不能超过1年。 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 | | 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。 订单创建开始时间与订单创建结束时间间隔不能超过1年。 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 | | service_type_code | 否 | String | 最大长度：64 | 云服务类型编码。例如OBS的云服务类型编码为"hws.service.type.obs"。大小写不敏感。 您可以调用[查询云服务类型列表-ListServiceTypes](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0000001256679455.html)接口获取。 此参数不携带或携带值为空时，不作为筛选条件；携带值为空串或携带值为null时，作为筛选条件。 | | status | 否 | Integer | - | 订单状态： - 1：待审核 - 3：处理中 - 4：已取消 - 5：已完成 - 6：待支付 - 9：待确认 此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 | | order_type | 否 | String | 最大长度：64 | 订单类型： - 1：开通 - 2：续订 - 3：变更 - 4：退订 - 10：包年/包月转按需 - 11：按需转包年/包月 - 13：试用 - 14：转商用 - 15：费用调整 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 | | limit | 否 | Integer | \[1-100\] | 每次查询的订单数量，默认值为10。 此参数不携带或携带值为空或携带值为null时，取默认值10；不支持携带值为空串。 | | offset | 否 | Integer | \[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。 | | order_by | 否 | String | 最大长度：36 | 查询的订单列表排序。大小写不敏感。 支持按照创建时间进行排序，带-表示倒序。 创建时间：升序为createTime，倒序为-createTime。 此参数不携带或携带值为空或携带值为空串或携带值为null时，按照创建时间倒序排列。 | | 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。 订单支付开始时间与订单支付结束时间间隔不能超过1年。 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 | | 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。 订单支付开始时间与订单支付结束时间间隔不能超过1年。 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 | | indirect_partner_id | 否 | String | 最大长度：64 | 云经销商ID。获取方法请参见[查询云经销商列表](https://support.huaweicloud.com/api-bpconsole/espp_00003.html)。 华为云总经销商（一级经销商）查询云经销商的客户订单列表时，需要携带该参数，否则只能查询自己客户的订单列表。 | | method | 否 | String | 最大长度：64 | 查询方式。 - oneself：客户自己订单 - sub_customer：客户给企业子代付订单 此参数不携带或携带值为空串或携带值为null时，默认值为"oneself"。 | #### 请求消息 请求参数 无。 请求示例 ``` 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.obs&status=5&order_type=1&limit=10&offset=0&order_by=-createTime&payment_time_begin=2020-05-06T08:05:01Z&payment_time_end=2020-05-07T08:05:01Z&indirect_partner_id=646988ef4cdb3122834feswrygfd&paying_agent_id=646988ef4cdb3122834feswrygfd HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ ``` #### 响应消息 响应参数 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 最大长度：20 | 状态码。 具体请参见[状态码]。 | | error_msg | String | 最大长度：2000 | 错误描述信息。 | | total_count | Integer | 大于或等于0的整数 | 大于或等于0的整数。 符合条件的记录总数。 | | order_infos | List\ | - | 客户订单详情信息。 具体请参见[表2] | 表2CustomerOrderV2 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | order_id | String | 最大长度：64 | 订单ID。 | | customer_id | String | 最大长度：64 | 客户账号ID。 | | service_type_code | String | 最大长度：6400 | 云服务类型编码。例如OBS的云服务类型编码为"hws.service.type.obs"。 说明： 查询组合单时，该字段由各子订单的云服务类型编码以逗号分隔组合拼接而成。 | | service_type_name | String | 最大长度：200000 | 云服务类型名称。例如ECS的云服务类型名称为"弹性云服务器"。 说明： 查询组合单时，该字段由各子订单的云服务类型名称以逗号分隔组合拼接而成。 | | source_type | Integer | - | 客户订单来源类型： - 1：客户 - 2：代理 - 3：合同 - 4：分销商 - 5：页面删除资源 - 6：补录订单 - 7：补偿订单 - 8：系统自动创建 说明： 以下场景产生的订单由系统自动创建： - 开通失败，自动退订，创建退订的订单 - 组合（含硬件）云服务开通失败、硬件订单失败自动退订 - 硬件换货场景，自动创建退货订单 - 自动续费创建的续费订单 | | 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。 | | currency | String | 最大长度：4 | 货币编码。 | | contract_id | String | 最大长度：64 | 合同ID。 | | amount_info | AmountInfoV2 Object | - | 订单扣费详情。 具体请参见[表3]。 | | enterprise_projects | List\ | - | 客户订单企业项目详情信息。 具体请参见[表5]。 说明： 批量退订、续订场景下各订单的企业项目信息，可通过各订单ID区分查询。 | | sub_order_infos | List\ | - | 客户订单下属的订单详情信息。 具体请参见[表6] 说明： 当查询订单为组合交易订单时，订单信息会返回下属的订单信息，当查询为普通订单时，此字段返回为空。 | | agent_pay_info | AgentPayInfoV2 Object | - | 客户订单代理支付信息。 具体请参见[表 AgentPayInfoV2] | 表3AmountInfoV2 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | discounts | List\ | - | 费用项。 具体请参见[表4]。 | | flexipurchase_coupon_amount | Double | - | 现金券金额。 | | coupon_amount | Double | - | 代金券金额。 | | stored_card_amount | Double | - | 储值卡金额。 | | commission_amount | Double | - | 手续费（仅退订订单存在）。 | | consumed_amount | Double | - | 消费金额（仅退订订单存在）。 | 表4DiscountItemV2 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | 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 | - | 折扣金额。 | 表5EnterpriseProject | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | id | String | 最大长度：256 | 企业项目id。 | | name | String | 最大长度：256 | 企业项目名称。 | 表6SubCustomerOrderV2 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | order_id | String | 最大长度：64 | 订单ID。 | | customer_id | String | 最大长度：64 | 客户账号ID。 | | service_type_code | String | 最大长度：64 | 云服务类型编码。例如OBS的云服务类型编码为"hws.service.type.obs"。 | | service_type_name | String | 最大长度：200 | 云服务类型名称。例如ECS的云服务类型名称为"弹性云服务器"。 | | source_type | Integer | - | 客户订单来源类型： - 1：客户 - 2：代理 - 3：合同 - 4：分销商 - 5：页面删除资源 - 6：补录订单 - 7：补偿订单 - 8：系统自动创建 说明： 以下场景产生的订单由系统自动创建： - 开通失败，自动退订，创建退订的订单 - 组合（含硬件）云服务开通失败、硬件订单失败自动退订 - 硬件换货场景，自动创建退货订单 - 自动续费创建的续费订单 | | 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。 | | currency | String | 最大长度：4 | 货币编码。 | | contract_id | String | 最大长度：64 | 合同ID。 | | amount_info | AmountInfoV2 Object | - | 订单扣费详情。 具体请参见[表3]。 | | enterprise_projects | List\ | - | 客户订单企业项目详情信息。 具体请参见[表5]。 说明： 批量退订、续订场景下各订单的企业项目信息，可通过各订单ID区分查询。 | 表7AgentPayInfoV2 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | paying_agent_id | String | 最大长度：64 | 订单代理支付人的客户账号ID。 | | is_agent_pay | Boolean | -- | 是否代理支付。 true：代理支付 当值不为true时，代表订单为非代理支付订单。 | 响应示例: ``` 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": "CS2405161952CE7IU5QmodifyJobAndPartFailJob", "customer_id": "0c7fd9bdfb80d4170fb1c0056128d420", "service_type_code": "hws.service.type.ec2", "service_type_name": "弹性云服务器", "source_type": 1, "status": 5, "order_type": 1, "amount_after_discount": 274.6, "official_amount": 349.5, "measure_id": 1, "create_time": "2024-05-16T11:52:10Z", "payment_time": "2024-05-16T12:18:35Z", "currency": "CNY", "contract_id": null, "amount_info": { "discounts": [ { "discount_type": "700", "discount_amount": 69.9 }, { "discount_type": "301", "discount_amount": 5.0 } ], "flexipurchase_coupon_amount": 0.0, "coupon_amount": 5.0, "stored_card_amount": 0.0, "commission_amount": null, "consumed_amount": null }, "enterprise_projects": [ { "id": "0", "name": "default" } ], "sub_order_infos": [], "agent_pay_info": { "paying_agent_id": "0a08c7277280d5ff0ff6c00643c406c0", "is_agent_pay": true } } ] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 400 | CBC.0101 | 参数无效。 | | 400 | CBC.99000037 | 您没有操作该云经销商的权限。 | | 403 | CBC.0155 | 不允许执行当前请求。 原因可能为账号鉴权信息不正确、账号或子账号没有接口调用权限。 | | 500 | CBC.0999 | 其他错误。 |