智简魔方文档

GET 前台商品配置信息

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/idcsmart_common/product/{product_id}/configoption
所属业务模块
来源模块/系统通用商品
认证方式Bearer Token(用户令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

前台商品配置信息

请求参数

名称位置类型必选说明
product_idpathinteger(int32)商品ID

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)状态码
msgstring提示信息
dataobject
data.common_productobject商品基础信息
data.common_product.namestring商品名称
data.common_product.order_page_descriptionstring订购页面html
data.common_product.allow_qtyinteger(int32)是否允许选择数量:1是,0否默认
data.common_product.pay_typestring付款类型(免费free,一次onetime,周期先付recurring_prepayment,周期后付recurring_postpaid
data.configoptions[object]配置项信息
data.configoptions[].idinteger(int32)配置项ID
data.configoptions[].option_namestring配置项名称
data.configoptions[].option_typestring配置项类型:select下拉单选,multi_select下拉多选,radio点击单选,quantity数量输入,quantity_range数量拖动,yes_no是否,area区域,cascade级联
data.configoptions[].qty_mininteger(int32)数量时最小值
data.configoptions[].qty_maxinteger(int32)数量时最大值
data.configoptions[].unitstring单位
data.configoptions[].allow_repeatinteger(int32)数量类型时:是否允许重复:开启后,前台购买时,可通过点击添加按钮,自动创建一个新的配置项,取名如bw1
data.configoptions[].max_repeatinteger(int32)最大允许重复数量
data.configoptions[].descriptionstring说明
data.configoptions[].qty_changeinteger(int32)数量变化值
data.configoptions[].is_showinteger(int32)是否展示配置项名称:1是,0否
data.configoptions[].subs[object]子项信息
data.configoptions[].subs[].idinteger(int32)子项ID
data.configoptions[].subs[].option_namestring子项名称
data.configoptions[].subs[].qty_mininteger(int32)子项最小值
data.configoptions[].subs[].qty_maxinteger(int32)子项最大值
data.configoptions[].tree[object]级联配置项的树形结构数据(仅当option_type为cascade时返回)
data.configoptions[].tree[].item_idinteger(int32)级联项ID
data.configoptions[].tree[].item_namestring级联项名称
data.configoptions[].tree[].fee_typestring计费类型
data.configoptions[].tree[].group_idinteger(int32)级联组ID
data.configoptions[].tree[].is_leafinteger(int32)是否为末端项:1是,0否
data.configoptions[].tree[].orderinteger(int32)排序
data.configoptions[].tree[].hiddeninteger(int32)是否隐藏:1是,0否
data.configoptions[].tree[].children[string]子级联项(递归结构)
data.configoptions[].tree[].price[string]价格信息(仅末端项有此字段)
data.configoptions[].cascade_group[object]级联组信息(仅当option_type为cascade时返回)
data.configoptions[].cascade_group[].idinteger(int32)级联组ID
data.configoptions[].cascade_group[].group_namestring级联组名称
data.cyclesobject周期({"onetime":1.00})
data.custom_cycles[object]自定义周期
data.custom_cycles[].idinteger(int32)自定义周期ID
data.custom_cycles[].namestring自定义周期名称
data.custom_cycles[].cycle_timeinteger(int32)自定义周期时长
data.custom_cycles[].cycle_unitstring自定义周期单位
data.custom_cycles[].amountnumber(double)商品自定义周期金额
data.custom_cycles[].cycle_amountnumber(double)(商品+配置项)自定义周期金额
data.custom_cycles[].is_defaultinteger(int32)是否默认:1是,0否

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)错误状态码
msgstring错误提示