文档首页/ 云商店/ 接入指南/ 商品接入相关接口/ 联营License客户端软件对接指南/ 云商店开放接口指南/ 接口列表/ 查询订单
更新时间：2024-04-26 GMT+08:00
查看PDF
分享

查询订单

功能介绍

云商店商家可通过该接口查询订单所有信息。

URI

GET ：

https://mkt.myhuaweicloud.com/api/mkp-openapi-public/global/v1/order/query

参数说明请参见响应消息。

仅支持https协议。

“mkt.myhuaweicloud.com”域名不可用时请使用“mkt.myhuaweicloud.cn”进行重试。

请求消息

请求参数

请求方法：GET

参数

是否必选

参数类型

取值范围

描述

orderId

M

String

64

云商店订单ID

orderLineId

O

String

64

云商店订单行ID

需要对mkt.myhuaweicloud.com HTTPS证书进行强校验，不能忽略证书校验，从而保证调用的是真实而非伪造的云商店服务。

请求示例

GET /api/mkp-openapi-public/global/v1/order/query?orderId=CS2207261447AUY4H&orderLineId=CS2207261447AUY4H-000001 
Host: Host Server    
Content-Type: application/json charset=UTF-8   
X-Sdk-Date: request time     
Authorization: authorization

响应消息

表1 响应参数

参数

是否必选

参数类型

取值范围

描述

resultCode

M

String

16

结果码。

resultMsg

M

String

1024

结果消息。

orderInfo

O

OrderInfo

/

附加信息。

OrderInfo数据结构定义

OrderInfo数据结构定义如下：

参数

是否必选

参数类型

最大字符长度

说明

orderId

M

String

64

云商店订单号

orderType

M

String

32

订单类型，可用枚举：

  • NEW：新购订单
  • TRIAL：试用订单
  • TRIAL_TO_FORMAL：试用转正订单
  • UNSUBSCRIBE：退订订单
  • RENEW：续费订单
  • CHANGE：变更订单

createTime

M

DateTime

20

订单创建时间。

格式：yyyyMMddHHmmss

不是订单生效时间，只表示用户下单的时间

orderLine

M

List<OrderLine>

/

订单行信息

buyerInfo

O

BuyerInfo

/

客户信息

extendParams

O

List<ExtendParam>

/

扩展参数。非必填。

扩展参数格式为key/value格式的数组。

OrderLine数据结构定义如下：

参数

是否必选

参数类型

最大字符长度

说明

orderLineId

M

String

64

云商店订单行ID

chargingMode

M

String

25

计费模式。

ON_DEMAND：按需计费

ONE_TIME：一次性计费

PERIOD：包周期计费

ON_DEMAND_PKG：按需套餐包。

expireTime

O

DateTime

20

过期时间。

格式：yyyyMMddHHmmss

  • 按周期售卖的商品，会请求该参数。
  • 按次售卖的商品，不会请求该参数。

过期时间根据订单创建时间和购买周期计算而来，与订单实际过期时间有误差，仅供参考。

periodType

O

String

2

周期类型。

说明：

非必传，如需此参数，计费类型需选择包周期chargingMode= PERIOD，包周期购买场景请求时传该参数。

天："day"

年："year"

月："month"

extendParams

O

List<ExtendParam>

/

扩展参数。非必填。

扩展参数格式为key/value格式的数组。

例如：[{"name":"emailDomainName","value":"test.xxxx.com"},{"name":"ip","value":"192.168.1.1"}]

其中emailDomainName和ip为发布商品时填写值。

currency

O

String

64

订单金额，新购、续费、变更等正向场景下金额为正，退订、退续费等逆向场景金额为空

currencyAfterDiscount

O

String

25

订单成交金额，不包含代金券以及折扣的金额，新购、续费、变更等正向场景下金额为正，退订、退续费等逆向场景金额为负

periodNumber

O

integer

5

周期数量。

说明：

非必传，如需此参数，计费类型需选择包周期chargingMode= PERIOD，包周期购买场景请求时传该参数。

周期数量：1,2,3…

productInfo

M

List<ProductInfo>

/

订单行关联的商品信息

ProductInfo数据结构定义如下：

参数

是否必选

参数类型

最大字符长度

说明

productId

M

String

64

产品标识，同一skuCode下，不同周期类型的productId不同。

例如：ISV发布产品，新增一个规格，会生成一个skuCode，再配置包年价格，包月价格，会生成两个productId。

该参数可在商品审核上架后，进入“卖家中心 > 商品管理 > 我的商品 ”页面，单击该商品操作列的“详情”进入商品详情页面获取。

skuCode

M

String

64

产品规格标识。租户购买包月或包年的产品后，可能会续费，续费支持变更周期类型（例如包月转包年），此时，租户开通的实例instanceId对应的productId会变化，但skuCode不变。

该参数可在商品审核上架后，进入“卖家中心 > 商品管理 > 我的商品 ”页面，单击该商品操作列的“详情”进入商品详情页面获取。

linearValue

O

Integer

/

线性单位值，如果当前商品存在数量属性，用户在下单时选择的线性数值

productName

M

String

/

商品名称

ExtendParam数据结构定义如下：

参数

是否必选

参数类型

最大字符长度

说明

name

M

String

64

参数名

value

M

String

64

参数的值

BuyerInfo数据结构定义如下：

参数

是否必选

参数类型

最大字符长度

说明

mobilePhone

O

String

64

用户手机号

customerId

O

String

64

客户ID

customerName

O

String

64

客户账号名

email

O

String

64

用户邮箱

userId

O

String

64

用户ID

userName

O

String

64

用户名

成功响应示例

{ 
	"resultCode": "MKT.0000", 
	"resultMsg": "Success", 
	"orderInfo": { 
		"orderId": "MOC*******RNEW", 
		"orderType": "NEW", 
		"createTime": "20230713082130", 
		"orderLine": [ 
			{ 
				"orderLineId": "MOCKP*********001", 
				"chargingMode": "PERIOD", 
				"periodType": "year", 
				"periodNumber": 1, 
				"expireTime": "20240713082130", 
				"productInfo": [ 
					{ 
						"productId": "OFFI84******911168", 
						"skuCode": "0a4d1578-5295-46a7-92d4-7c803dccc51d", 
						"linearValue": 50, 
						"productName": "****,*****,*****,******" 
					} 
				], 
				"extendParams": [ 
					{ 
						"name": "emailDomainName", 
						"value": "test.xxxx.com" 
					}, 
					{ 
						"name": "ip", 
						"value": "127.0.0.1" 
					} 
				] 
			} 
		], 
		"buyerInfo": { 
			"mobilePhone": "1868*****88", 
			"email": "*****t.com", 
			"customerId": "459bbbec25********37b602a8", 
			"customerName": "mock_******" 
		} 
	} 
}

失败响应示例

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time {  
    "resultCode": "CBC.0150",  
    "resultMsg": "Illegal operation. param[isvId] and param[instanceId] does not match."  
}
父主题： 接口列表

相关文档