创建商城订单
创建商城订单
请求说明
| 请求地址 | https://openapi.wps.cn/v7/store/orders/create |
|---|---|
| 请求方法 | POST |
| 签名方式 | KSO-1 |
| 权限要求 | 允许应用创建商城订单（应用授权） kso.store_order.readwrite |
请求头（Header）
| Header 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用：application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值，详见《签名方法》 |
| Authorization | string | 是 | 授权凭证，格式为：Bearer {access_token} |
请求体（Body）
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| delivery | object | 是 | 订购内容的交付参数 |
| ∟ notify_email | string | 否 | 订单交付通知的收件人 |
| ∟ notify_phone | string | 否 | 订单交付通知的手机号码 |
| ∟ type | string[enum] | 是 | 交付方式 activation_code；instant |
| entity | object | 是 | 订购商品的实体信息 |
| ∟ id | string | 否 | 订购商品的实体 id；具体的值取决于 entity.type：当 entity.type=company 时，该参数值等于企业 id |
| ∟ name | string | 否 | 订购商品的实体名称 |
| ∟ type | string[enum] | 否 | 订购商品的实体类型 user；app；company |
| partner | object | 是 | 订单的生态合作商信息 |
| ∟ name | string | 否 | 合作商标识 |
| purchase_type | string[enum] | 是 | 订单采购类型 trial；buy；gift_with_buy；internal_test |
| remark | string | 是 | 订单备注信息 |
| request_id | string | 是 | 请求 id，防重复提交。由调用方保证唯一性，并妥善保存所有成功请求的 request_id，用于对账 |
| skus | array[object] | 是 | 订购商品的列表 |
| ∟ actual_fee | integer | 是 | 订购商品的实付费用（单位：分） |
| ∟ amount | integer | 是 | 订购商品的数目 |
| ∟ out_entitlement_key | string | 否 | 商品授权 key，表示的是当前订购内容生效后产生的授权标识；是一个字符串，由调用方产生并保证唯一性 |
| ∟ sku_id | string | 是 | 订购的商品版本 id |
| ∟ term | integer | 是 | 订购商品的时长数值，单位由 term_by 指定 |
| ∟ term_by | string[enum] | 是 | 订购商品的时长单位 day；month；year |
| ∟ with_new_entitlement | boolean | 否 | 指示本次下单是否要新增授权，默认是 false |
| utm | object | 是 | 订单的 utm 信息，用于记录订购的业务属性 |
| ∟ campaign | string | 否 | utm 活动， 调用方自行定义 |
| ∟ content | string | 否 | utm 内容， 调用方自行定义 |
| ∟ medium | string | 否 | utm 来源媒介， 调用方自行定义 |
| ∟ source | string[enum] | 是 | 订单来源 open_eco_partner |
| ∟ term | string | 否 | utm 关键字， 调用方自行定义 |
请求地址示例
[POST] https://openapi.wps.cn/v7/store/orders/create请求体示例
json
{
"delivery": {
"notify_email": "string",
"notify_phone": "string",
"type": "string[enum]"
},
"entity": {
"id": "string",
"name": "string",
"type": "string[enum]"
},
"partner": {
"name": "string"
},
"purchase_type": "string[enum]",
"remark": "string",
"request_id": "string",
"skus": [
{
"actual_fee": 0,
"amount": 0,
"out_entitlement_key": "string",
"sku_id": "string",
"term": 0,
"term_by": "string[enum]",
"with_new_entitlement": false
}
],
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string[enum]",
"term": "string"
}
}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败，参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ activation | object | 产生的兑换码信息 |
| ∟ ∟ usage_url | string | 兑换码的使用地址 |
| ∟ order_id | string | 产生的订单 id |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"activation": {
"usage_url": "string"
},
"order_id": "string"
},
"msg": "string"
}