获取订单列表
接口描述
GET /v1/orders
获取订单列表
请求头(Request Header)
请求参数(Request Parameters)
名称 | 位置 | 类型 | 必须 | 描述 |
---|---|---|---|---|
filter | query | string | false | 过滤 |
order_by | query | string | false | 排序结果 |
page_size | query | integer(int32) | false | 返回当前页的最大条目数 |
page_token | query | string | false | 从上一个List请求返回的next_page_token值(如果有的话) |
resource_instance_id | query | string | false | 资源实例 uuid |
resource_type | query | array[string] | false | 资源类型 |
contract_display_name | query | string | false | 资源类型 |
resource_name | query | string | false | 资源类型 |
resource_display_name | query | string | false | 资源类型 |
请求体(Request Body)
无
请求示例(Request Example)
curl --request GET \
--url https://finance.sensecoreapi.dev/boss/subscription/v1/orders \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
响应参数(Response Parameters)
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ListOrdersResponse |
响应示例(Response Example)
200 Response
{
"orders": [
{
"id": "string",
"subscription_id": "string",
"resource_group_id": "string",
"subscription_name": "string",
"resource_group_name": "string",
"spu_name": "string",
"billing_day": 0,
"state": "OS_UNSPECIFIED",
"type": "OT_UNSPECIFIED",
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"auto_renew": true,
"change_policy": "SP_UNSPECIFIED",
"cancel_policy": "SP_UNSPECIFIED",
"original_id": "string",
"contract_display_name": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"discount_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"coupon_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"voucher_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"pay": "PC_UNSPECIFIED",
"note": "string",
"currency_code": "string",
"creator": "string",
"updater": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"details": [
{
"id": "string",
"order_id": "string",
"sku": {
"spu_id": "string",
"id": "string",
"display_name": "string",
"regions": [
"string"
],
"available_zones": [
"string"
],
"business_billing_cycle": "BBC_UNSPECIFIED",
"billing_cycle": "BC_UNSPECIFIED",
"billing_cycle_number": 0,
"payment_model": "PM_UNSPECIFIED",
"billing_model": "BM_UNSPECIFIED",
"price_model": "PIM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{
"currency_code": "string",
"units": 0,
"nanos": 0
}
]
}
],
"price_unit": "string",
"price_scale": 0,
"stock": 0,
"stock_unit": "string",
"discount": 0,
"max_quantity": 0,
"min_quantity": 0,
"have_trial": true,
"trial_count": 0,
"trial_unit": "string",
"effective_time": "2019-08-24T14:15:22Z",
"ineffective_time": "2019-08-24T14:15:22Z",
"one_time": true,
"cancel_policy": "SP_UNSPECIFIED",
"actions": [
"string"
],
"tags": [
"string"
],
"excess_sku_id": "string",
"attributes": [
{
"attribute_id": "string",
"display_name": "string",
"property_name": "string",
"value": "string",
"value_unit": "string",
"value_scale": 0,
"attribute_value_id": "string",
"attribute_type": "ATT_KEY"
}
],
"status": "ST_UNSPECIFIED",
"spu_name": "string",
"sku_billing_items": [
{
"id": "string",
"sku_id": "string",
"attribute_id": "string",
"display_name": "string",
"property_name": "string",
"value_unit": "string",
"price_model": "PIM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": []
}
],
"price_unit": "string",
"price_scale": 0,
"stock": 0,
"stock_unit": "string",
"max_quantity": 0,
"min_quantity": 0,
"value_scales": [
{
"value_unit": "string",
"value_scale": 0,
"attribute_value_id": "string"
}
],
"status": "ST_UNSPECIFIED",
"discount": 0,
"creator": "string",
"updater": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"meter_unit": "string"
}
],
"creator": "string",
"updater": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"meter_unit": "string",
"usage_scope": {
"tenant_ids": [
"string"
],
"scope_type": "UST_PUBLIC",
"scope_level": "USL_BACKEND_CATALOG"
}
},
"order_billing_items": [
{
"id": "string",
"billing_item_id": "string",
"number": 0,
"property_name": "string",
"display_name": "string",
"price_scale": 0,
"price_model": "PIM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{}
]
}
],
"discount": 0,
"value_unit": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"discount_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
],
"region_code": "string",
"zone": "string",
"currency_code": "string",
"payment_model": "PM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{
"currency_code": "string",
"units": 0,
"nanos": 0
}
]
}
],
"number": 0,
"billing_cycle": 0,
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"discount_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"coupon_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"voucher_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"free_quantity": 0,
"state": "OD_UNSPECIFIED",
"active_time": "2019-08-24T14:15:22Z",
"contract_detail_id": "string",
"creator": "string",
"updater": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"instances": [
{
"id": "string",
"resource_instance_id": "string",
"resource_instance_rid": "string",
"order_detail_id": "string",
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"subscription_name": "string",
"resource_group_name": "string",
"name": "string",
"display_name": "string"
}
],
"spu_name": "string",
"fulfill_rm_resource_row": "string",
"fulfill_rm_message_body": "string",
"fulfill_rm_topic": "string",
"meter_rules": [
{
"id": "string",
"order_detail_id": "string",
"tier": 0,
"max_value": 0,
"price": 0
}
],
"resource_type": "string",
"properties": {
"@type": "string"
}
}
],
"name": "string",
"creator_name": "string",
"unsubscription_reason": "string",
"cancel_renew_flag": true,
"initial_id": "string",
"transferred_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"resource_diff_value": "string",
"ba_departed_amounts": [
{
"billing_account_display_name": "string",
"billing_account_id": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"currency_code": "string",
"depart_ratio": 0,
"trans_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"refund_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
],
"contract_ver": "string",
"auto_convert_postpaid": true,
"ba_recommend_voucher_instances": [
{
"billing_account_id": "string",
"recommend_voucher_instance": [
{
"voucher_instance": {
"id": "string",
"display_name": "string",
"voucher_issue_id": "string",
"billing_account_id": "string",
"backend_catalog_id": "string",
"backend_catalog_name": "string",
"backend_catalogs": [
{
"id": "string",
"display_name": "string",
"parent_id": "string",
"is_leaf": true,
"level": 0,
"order": 0,
"enable": true,
"url": "string",
"buy_url": "string",
"resource_types": [],
"have_descendants": true,
"backend_catalog_code": "string",
"creator": "string",
"updater": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"is_favorite": true,
"icon": "string",
"tags": [],
"introduction": "string",
"official_link": "string",
"help_link": "string",
"recommended_catalogs": [],
"has_resource": true,
"saleable": true,
"icon_code": "string",
"gray_release": true,
"tenant_whitelist": [],
"favorite_time": "2019-08-24T14:15:22Z",
"resource_type_group_ids": []
}
],
"denomination_value": 0,
"available_value": 0,
"effective_time": "2019-08-24T14:15:22Z",
"ineffective_time": "2019-08-24T14:15:22Z",
"state": "STATE_UNUSED",
"issuer_name": "string",
"creator": "string",
"updater": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"creator_name": "string",
"updater_name": "string"
},
"system_recommend": true,
"deduction_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"remaining_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
]
}
]
}
],
"next_page_token": "string",
"total_size": 0
}
数据结构(Schemas)
BaDepartedAmount
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
billing_account_display_name | string | false | none | 计费账户名称 |
billing_account_id | string | false | none | 计费账户ID |
amount | Money | false | none | 价格 |
currency_code | string | false | none | 实付金额 |
depart_ratio | integer(int32) | false | none | 实付金额 |
trans_amount | Money | false | none | 价格 |
refund_amount | Money | false | none | 价格 |
original_amount | Money | false | none | 价格 |
BaRecommendVoucherInstance
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
billing_account_id | string | false | none | 计费账户ID |
recommend_voucher_instance | [RecommendVoucherInstance] | false | none | 推荐的代金券实例列表 |
BackendCatalog
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | 品类ID create: require, if not assign id, give "" update: require |
display_name | string | true | none | create: require update: require, can be updated |
parent_id | string | true | none | create: require, if no parent, value is "00000000-0000-0000-0000-000000000000" update: require, can not be updated |
is_leaf | boolean | true | none | create: require update: not require, can not be updated |
level | integer(int32) | false | read-only | output only |
order | integer(int32) | false | read-only | output only |
enable | boolean | true | none | create: require, default true update: not require |
url | string | true | none | none |
buy_url | string | true | none | none |
resource_types | [string] | false | read-only | none |
have_descendants | boolean | false | read-only | none |
backend_catalog_code | string | true | none | none |
creator | string | false | read-only | output only |
updater | string | false | read-only | output only |
create_time | string(date-time) | false | read-only | output only |
update_time | string(date-time) | false | read-only | output only |
is_favorite | boolean | false | read-only | output only |
icon | string | false | none | dashboard图标 |
tags | [string] | false | read-only | output only |
introduction | string | false | none | none |
official_link | string | false | none | none |
help_link | string | false | none | none |
recommended_catalogs | [string] | false | none | none |
has_resource | boolean | false | read-only | none |
saleable | boolean | true | none | create: require, default true update: not require |
icon_code | string | false | read-only | output only |
gray_release | boolean | true | none | 灰度发布标记 |
tenant_whitelist | [string] | true | none | 租户白名单 |
favorite_time | string(date-time) | false | read-only | 收藏时间 |
resource_type_group_ids | [string] | true | none | 关联RP类型 |
ListOrdersResponse
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
orders | [Order] | true | none | 订单列表 |
next_page_token | string | false | none | 下一页 |
total_size | integer(int32) | false | none | 总记录 |
Money
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
currency_code | string | false | none | 货币代码, 参考ISO 4217 |
units | integer(int64) | false | none | 价格整数部分 |
nanos | integer(int32) | false | none | 价格小数部分 |
Order
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | 订单ID |
subscription_id | string | true | none | 订阅ID |
resource_group_id | string | false | none | 资源组ID |
subscription_name | string | false | read-only | 订阅名称 |
resource_group_name | string | false | read-only | 资源组名称 |
spu_name | string | false | read-only | 产品名称 |
billing_day | integer(int32) | false | read-only | 计费时间 |
state | string(enum) | false | read-only | 订单状态 |
type | string(enum) | true | none | 订单类型 |
start_time | string(date-time) | true | none | 开始时间 |
end_time | string(date-time) | true | none | 结束时间 |
auto_renew | boolean | true | none | 是否自动续订 |
change_policy | string(enum) | false | read-only | 修改策略 |
cancel_policy | string(enum) | false | read-only | 取消策略 |
original_id | string | true | none | 原始订单ID |
contract_display_name | string | false | read-only | 合同包名称,仅合同包订单时此字段非空 |
amount | Money | false | none | 价格 |
original_amount | Money | false | none | 价格 |
discount_amount | Money | true | none | 价格 |
coupon_amount | Money | true | none | 价格 |
voucher_amount | Money | true | none | 价格 |
pay | string(enum) | true | none | 支付方式 |
note | string | false | none | 备注信息 |
currency_code | string | true | none | 币种 |
creator | string | false | read-only | 创建者 |
updater | string | false | read-only | 更新者 |
create_time | string(date-time) | false | read-only | 创建时间 |
update_time | string(date-time) | false | read-only | 更新时间 |
details | [OrderDetail] | true | none | 订单详情 |
name | string | true | none | 名称 |
creator_name | string | false | read-only | 创建者名称 |
unsubscription_reason | string | false | read-only | 退订理由 |
cancel_renew_flag | boolean | false | read-only | 是否可“取消续订”标记 |
initial_id | string | false | read-only | 原订单ID |
transferred_amount | Money | false | none | 价格 |
resource_diff_value | string | false | read-only | 扩容前后资源用量差额 |
ba_departed_amounts | [BaDepartedAmount] | false | read-only | 多BA分摊金额 |
contract_ver | string | false | read-only | 多BA分摊金额 |
auto_convert_postpaid | boolean | false | none | 到期后是否自动转为后付费 |
ba_recommend_voucher_instances | [BaRecommendVoucherInstance] | false | read-only | 续订订单估值时返回的推荐代金券列表 |
state Enumerated Values
枚举值 |
---|
OS_UNSPECIFIED |
OS_PENDING |
OS_PAID |
OS_FAILED |
OS_PAYING |
OS_TIMEOUT |
OS_CANCELED |
OS_REFUNDING |
OS_REFUNDED |
OS_CREATE_FAILED |
OS_CREATE_TIMEOUT |
OT_UNSPECIFIED |
OT_ORIGINAL |
OT_RENEW |
OT_UPGRADED |
OT_DOWNGRADED |
OT_CONTRACT |
OT_UNSUBSCRIBE |
OT_RESIZE |
SP_UNSPECIFIED |
SP_IMMEDIATELY |
SP_ENDOFTERM |
SP_UNCONDITIONALLY_REFUND |
SP_NONREFUNDABLE |
SP_UNSPECIFIED |
SP_IMMEDIATELY |
SP_ENDOFTERM |
SP_UNCONDITIONALLY_REFUND |
SP_NONREFUNDABLE |
PC_UNSPECIFIED |
PC_BALANCE |
PC_CREDIT |
PC_FROZENACCOUNT |
PC_REMIT_OFFLINE |
PC_ALIPAY |
PC_UNIONPAY |
PC_REMIT_ONLINE |
PC_CONTRACT |
PC_WECHAT |
OrderBillingItem
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | ID |
billing_item_id | string | true | none | 计费项ID |
number | integer(int64) | true | none | 计费项数量 |
property_name | string | false | read-only | 计费项名称 |
display_name | string | false | read-only | 计费项展示名称 |
price_scale | integer(int64) | false | read-only | 价格 |
price_model | string(enum) | false | read-only | 计费模型 |
price | [Price] | false | read-only | 价格 |
discount | integer(int32) | false | read-only | 折扣 |
value_unit | string | false | none | 购买计费项数量 |
amount | Money | false | none | 价格 |
original_amount | Money | false | none | 价格 |
discount_amount | Money | false | none | 价格 |
price_model Enumerated Values
枚举值 |
---|
PIM_UNSPECIFIED |
PIM_FLATFEE |
PIM_PERUNIT |
PIM_TIERED |
PIM_VOLUME |
PIM_STAIRSTEP |
OrderDetail
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | 订单详情ID |
order_id | string | true | none | 归属的订单ID |
sku | Sku | true | none | 最小库存单元 |
order_billing_items | [OrderBillingItem] | true | none | 计费项 |
region_code | string | true | none | 地区 |
zone | string | true | none | 可用区 |
currency_code | string | true | none | 币种 |
payment_model | string(enum) | true | none | 付费模式 |
price | [Price] | false | read-only | 商品价格 |
number | integer(int32) | true | none | 商品购买数量 |
billing_cycle | integer(int32) | true | none | 商品购买周期 |
amount | Money | false | none | 价格 |
original_amount | Money | false | none | 价格 |
discount_amount | Money | false | none | 价格 |
coupon_amount | Money | false | none | 价格 |
voucher_amount | Money | false | none | 价格 |
free_quantity | integer(int32) | false | read-only | 试用量 |
state | string(enum) | false | read-only | 订单详情状态 |
active_time | string(date-time) | false | read-only | 生效时间 |
contract_detail_id | string | false | none | 合同包详情ID |
creator | string | false | read-only | 创建者 |
updater | string | false | read-only | 更新者 |
create_time | string(date-time) | false | read-only | 创建时间 |
update_time | string(date-time) | false | read-only | 更新时间 |
instances | [OrderedInstance] | true | none | 实例信息 |
spu_name | string | false | read-only | 产品名称 |
fulfill_rm_resource_row | string | false | none | RM侧资源信息 |
fulfill_rm_message_body | string | false | none | RM侧消息 |
fulfill_rm_topic | string | false | none | RM侧topic |
meter_rules | [OrderDetailMeterRule] | false | none | 计量规则 |
resource_type | string | false | read-only | 资源类型 |
properties | GoogleProtobufAny | false | none | Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. |
payment_model Enumerated Values
枚举值 |
---|
PM_UNSPECIFIED |
PM_PREPAID |
PM_POSTPAID |
OD_UNSPECIFIED |
OD_FUTURE |
OD_INTRIAL |
OD_ACTIVE |
OD_CANCELED |
OD_UPGRADED |
OD_COMPLETED |
OS_REFUNDING |
OS_REFUNDED |
OrderDetailMeterRule
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | ID |
order_detail_id | string | true | none | 订单详情ID |
tier | integer(int32) | true | none | 阶梯 |
max_value | integer(int32) | true | none | 最大量 |
price | integer(int64) | true | none | 单价 |
OrderedInstance
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | ID |
resource_instance_id | string | true | none | 资源实例 uuid |
resource_instance_rid | string | false | none | 资源实例 rid |
order_detail_id | string | true | none | 订单详情ID |
start_time | string(date-time) | false | read-only | 开始时间 |
end_time | string(date-time) | false | read-only | 结束时间 |
subscription_name | string | false | none | 订阅名称 subscription_name |
resource_group_name | string | false | none | 资源组名称 |
name | string | false | none | 名称 |
display_name | string | false | none | 展示名称 |
Price
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
tier | integer(int32) | false | none | 层次 |
name | string | false | none | 层次名称 |
max_value | integer(int64) | false | none | 每层最大值 |
money | [Money] | false | none | 价格 |
RecommendVoucherInstance
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
voucher_instance | VoucherInstance | false | none | 代金券实例 |
system_recommend | boolean | false | none | 是否系统自动推荐:true是, false否 |
deduction_amount | Money | false | none | 价格 |
remaining_amount | Money | false | none | 价格 |
Sku
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
spu_id | string | true | none | 隶属标准化产品单元id |
id | string | false | read-only | 最小库存单元id |
display_name | string | true | none | 最小库存单元名称 |
regions | [string] | true | none | 可售卖区域 |
available_zones | [string] | true | none | 可售卖可用区 |
business_billing_cycle | string(enum) | true | none | 计费周期, 默认每小时; |
billing_cycle | string(enum) | true | none | 账单周期, 默认按月出账; |
billing_cycle_number | integer(int32) | true | none | 账单周期数 |
payment_model | string(enum) | true | none | 付费模式 |
billing_model | string(enum) | true | none | 计费模式 |
price_model | string(enum) | true | none | 计费模型 |
price | [Price] | true | none | 价格 |
price_unit | string | true | none | 价格单位 |
price_scale | integer(int64) | true | none | 价格上报尺度 |
stock | integer(int64) | true | none | 库存数量 |
stock_unit | string | true | none | 库存单位 |
discount | integer(int32) | true | none | 折扣, 从0-100, 100表示不打折 |
max_quantity | integer(int64) | false | none | 最多可售卖数量 |
min_quantity | integer(int64) | false | none | 最少可售卖数量 |
have_trial | boolean | false | none | 是否含有试用期 |
trial_count | integer(int64) | false | none | 试用数量 |
trial_unit | string | false | none | 试用单位 |
effective_time | string(date-time) | true | none | 生效时间(已弃用) |
ineffective_time | string(date-time) | true | none | 失效时间(已弃用) |
one_time | boolean | false | none | 是否只能购买一次 |
cancel_policy | string(enum) | false | none | 退订规则 |
actions | [string] | false | none | 此字段已弃用 |
tags | [string] | false | none | 此字段已弃用 |
excess_sku_id | string | false | none | 此字段已弃用 |
attributes | [SkuAttribute] | false | none | 关联的规格和描述属性 |
status | string(enum) | false | read-only | 上下架状态 |
spu_name | string | false | read-only | 关联的标准化产品单元名称 |
sku_billing_items | [SkuBillingItem] | true | none | 关联的计费项 |
creator | string | false | read-only | 创建者id |
updater | string | false | read-only | 更新者id |
create_time | string(date-time) | false | read-only | 创建时间 |
update_time | string(date-time) | false | read-only | 更新时间 |
meter_unit | string | true | none | 计量上报单位 |
usage_scope | UsageScope | false | none | 更新时间 |
business_billing_cycle Enumerated Values
枚举值 |
---|
BBC_UNSPECIFIED |
BBC_HOURLY |
BBC_DAILY |
BBC_WEEKLY |
BBC_MONTHLY |
BBC_QUARTERLY |
BBC_YEARLY |
BC_UNSPECIFIED |
BC_HOURLY |
BC_DAILY |
BC_WEEKLY |
BC_MONTHLY |
BC_QUARTERLY |
BC_YEARLY |
PM_UNSPECIFIED |
PM_PREPAID |
PM_POSTPAID |
BM_UNSPECIFIED |
BM_USAGE |
BM_MONTHLY |
BM_YEARLY |
PIM_UNSPECIFIED |
PIM_FLATFEE |
PIM_PERUNIT |
PIM_TIERED |
PIM_VOLUME |
PIM_STAIRSTEP |
SP_UNSPECIFIED |
SP_IMMEDIATELY |
SP_ENDOFTERM |
SP_UNCONDITIONALLY_REFUND |
SP_NONREFUNDABLE |
ST_UNSPECIFIED |
ST_RELEASE |
ST_UNRELEASED |
SkuAttribute
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
attribute_id | string | false | none | 属性id |
display_name | string | false | none | 属性名称 |
property_name | string | false | none | 属性后端名称 |
value | string | false | none | 属性值 |
value_unit | string | false | none | 属性单位 |
value_scale | integer(int64) | false | none | value scale |
attribute_value_id | string | false | none | 属性值id |
attribute_type | string(enum) | false | none | 属性类型 |
attribute_type Enumerated Values
枚举值 |
---|
ATT_KEY |
ATT_SPEC |
ATT_DESCRIPTION |
ATT_BILLING_ITEM |
SkuBillingItem
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | true | none | 计费项id |
sku_id | string | true | none | 最小库存单元id |
attribute_id | string | true | none | 关联计费属性id |
display_name | string | false | read-only | 计费项名称 |
property_name | string | false | read-only | 属性后端名称 |
value_unit | string | true | none | 属性单位 |
price_model | string(enum) | true | none | 价格模型 |
price | [Price] | true | none | 价格 |
price_unit | string | true | none | 价格单位 |
price_scale | integer(int64) | true | none | 价格尺度 |
stock | integer(int64) | true | none | 库存 |
stock_unit | string | true | none | 库存单位 |
max_quantity | integer(int64) | true | none | 计费项数量上限 |
min_quantity | integer(int64) | true | none | 计费项数量下限 |
value_scales | [ValueScale] | false | read-only | 单位换算关系 |
status | string(enum) | true | none | 状态 |
discount | integer(int32) | true | none | 折扣 |
creator | string | false | read-only | 创建者 |
updater | string | false | read-only | 更新者 |
create_time | string(date-time) | false | read-only | 创建时间 |
update_time | string(date-time) | false | read-only | 更新时间 |
meter_unit | string | true | none | 计量上报单位 |
price_model Enumerated Values
枚举值 |
---|
PIM_UNSPECIFIED |
PIM_FLATFEE |
PIM_PERUNIT |
PIM_TIERED |
PIM_VOLUME |
PIM_STAIRSTEP |
ST_UNSPECIFIED |
ST_RELEASE |
ST_UNRELEASED |
UsageScope
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
tenant_ids | [string] | false | none | 更新时间 |
scope_type | string(enum) | false | none | 更新时间 |
scope_level | string(enum) | false | none | 更新时间 |
scope_type Enumerated Values
枚举值 |
---|
UST_PUBLIC |
UST_SPECIFIED |
USL_BACKEND_CATALOG |
USL_SPU |
USL_SKU |
ValueScale
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
value_unit | string | false | none | 属性单位 |
value_scale | integer(int64) | false | none | 换算倍数 |
attribute_value_id | string | false | none | 属性值id |
VoucherInstance
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | false | read-only | 代金券编号 |
display_name | string | false | read-only | 代金券名称 |
voucher_issue_id | string | false | read-only | 发放ID |
billing_account_id | string | false | read-only | 归属账户 |
backend_catalog_id | string | false | read-only | 限制品类ID,多个ID之间以;分割 |
backend_catalog_name | string | false | read-only | [废弃字段]品类名称 |
backend_catalogs | [BackendCatalog] | false | read-only | 限制品类信息列表 |
denomination_value | integer(int64) | false | read-only | 券面额:小数点后3位,最少0.01 |
available_value | integer(int64) | false | read-only | 券余额:小数点后3位,最少0.01 |
effective_time | string(date-time) | false | read-only | 生效时间 |
ineffective_time | string(date-time) | false | read-only | 失效时间 |
state | string(enum) | false | read-only | 使用状态,未使用、使用中、已使用、已失效、已回收 |
issuer_name | string | false | read-only | 发放者 中文名 |
creator | string | false | read-only | 代金券名称 |
updater | string | false | read-only | output only |
create_time | string(date-time) | false | read-only | none |
update_time | string(date-time) | false | read-only | none |
creator_name | string | false | read-only | none |
updater_name | string | false | read-only | none |
state Enumerated Values
枚举值 |
---|
STATE_UNUSED |
STATE_INUSE |
STATE_USED |
STATE_EXPIRED |
STATE_RECYCLED |