GET 获取订购页面配置
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/product/{id}/rewhmcs_cloud/order_page |
| 所属业务 | 模块 |
| 来源模块/系统 | 魔方云代理(WHMCS) |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
获取订购页面配置
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 商品 ID |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
| data | object | 否 | — | — | — |
| data.cycle | [string] | 否 | — | — | 周期 |
| data.pricing | object | 否 | — | — | 商品价格 |
| data.pricing.setupfee | string | 否 | — | — | 一次性初装费 |
| data.pricing.msetupfee | string | 否 | — | — | 月初装费 |
| data.pricing.qsetupfee | string | 否 | — | — | 季初装费 |
| data.pricing.ssetupfee | string | 否 | — | — | 半年初装费 |
| data.pricing.asetupfee | string | 否 | — | — | 年初装费 |
| data.pricing.bsetupfee | string | 否 | — | — | 两年初装费 |
| data.pricing.tsetupfee | string | 否 | — | — | 三年初装费 |
| data.pricing.onetime | string | 否 | — | — | 一次性 |
| data.pricing.monthly | string | 否 | — | — | 月付 |
| data.pricing.quarterly | string | 否 | — | — | 季付 |
| data.pricing.semiannually | string | 否 | — | — | 半年付 |
| data.pricing.annually | string | 否 | — | — | 年付 |
| data.pricing.biennially | string | 否 | — | — | 两年付 |
| data.pricing.triennially | string | 否 | — | — | 三年付 |
| data.configoption | [object] | 否 | — | — | 配置 |
| data.configoption[].id | integer(int32) | 否 | — | — | 配置项 ID |
| data.configoption[].optionname | string | 否 | — | — | 配置项名称 |
| data.configoption[].firstname | string | 否 | — | — | 配置项真实值 |
| data.configoption[].lastname | string | 否 | — | — | 配置项描述 |
| data.configoption[].optiontype | string | 否 | — | — | 配置项类型1下拉2单选3是否4数量 |
| data.configoption[].qtyminimum | integer(int32) | 否 | — | — | 配置项最小值,类型为数量时才有 |
| data.configoption[].qtymaximum | integer(int32) | 否 | — | — | 配置项最大值,类型为数量时才有 |
| data.configoption[].options | [object] | 否 | — | — | 配置子项 |
| data.configoption[].options[].id | integer(int32) | 否 | — | — | 配置子项 ID |
| data.configoption[].options[].optionname | string | 否 | — | — | 配置子项名称 |
| data.configoption[].options[].firstname | string | 否 | — | — | 配置子项真实值 |
| data.configoption[].options[].lastname | string | 否 | — | — | 配置子项描述 |
| data.configoption[].options[].currency | integer(int32) | 否 | — | — | 货币 |
| data.configoption[].options[].setupfee | string | 否 | — | — | 一次性初装费 |
| data.configoption[].options[].msetupfee | string | 否 | — | — | 月初装费 |
| data.configoption[].options[].qsetupfee | string | 否 | — | — | 季初装费 |
| data.configoption[].options[].ssetupfee | string | 否 | — | — | 半年初装费 |
| data.configoption[].options[].asetupfee | string | 否 | — | — | 年初装费 |
| data.configoption[].options[].bsetupfee | string | 否 | — | — | 两年初装费 |
| data.configoption[].options[].tsetupfee | string | 否 | — | — | 三年初装费 |
| data.configoption[].options[].onetime | string | 否 | — | — | 一次性 |
| data.configoption[].options[].monthly | string | 否 | — | — | 月付 |
| data.configoption[].options[].quarterly | string | 否 | — | — | 季付 |
| data.configoption[].options[].semiannually | string | 否 | — | — | 半年付 |
| data.configoption[].options[].annually | string | 否 | — | — | 年付 |
| data.configoption[].options[].biennially | string | 否 | — | — | 两年付 |
| data.configoption[].options[].triennially | string | 否 | — | — | 三年付 |
| data.customfield | [object] | 否 | — | — | 自定义字段 |
| data.customfield[].id | integer(int32) | 否 | — | — | 自定义字段 ID |
| data.customfield[].fieldname | string | 否 | — | — | 自定义字段名称 |
| data.customfield[].fieldtype | string | 否 | — | — | 自定义字段类型text,textarea,tickbox,link,password,dropdown |
| data.customfield[].description | string | 否 | — | — | 自定义字段描述 |
| data.customfield[].fieldoptions | string | 否 | — | — | 自定义字段选项,以,分隔 |
| data.customfield[].regexpr | string | 否 | — | — | 自定义字段验证规则 |
| data.customfield[].required | string | 否 | — | — | 是否必填on是 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |