主题
商品管理
获取商品一级分组
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取商品一级分组 |
| 接口地址 | /console/v1/product/group/first |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:商品一级分组 |
| list[].id | int | - | desc:商品一级分组ID |
| list[].name | int | - | desc:商品一级分组名称 |
| list[].type | int | - | desc:分组类型 |
| count | int | - | desc:商品一级分组总数 |
获取商品二级分组
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取商品二级分组 |
| 接口地址 | /console/v1/product/group/second |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:optional | desc:一级分组ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:商品二级分组 |
| list[].id | int | - | desc:商品二级分组ID |
| list[].name | int | - | desc:商品二级分组名称 |
| list[].parent_id | int | - | desc:商品一级分组ID |
| list[].type | int | - | desc:分组类型 |
| list[].description | string | - | desc:描述 |
| count | int | - | desc:商品二级分组总数 |
商品列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 商品列表 |
| 接口地址 | /console/v1/product |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| keywords | string | - | 搜索范围商品ID商品名描述validate:optional | desc:关键字 |
| id | int | - | validate:optional | desc:二级分组ID |
| page | int | - | validate:optional | desc:页数 |
| limit | int | - | validate:optional | desc:每页条数 |
| exclusive | bool | - | validate:optional | desc:是否只返回专属商品 |
| product_ids | array | - | validate:optional | desc:筛选哪些商品 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:商品列表 |
| list[].id | int | - | desc:ID |
| list[].name | string | - | desc:商品名 |
| list[].description | string | - | desc:描述 |
| list[].pay_type | string | - | desc:付款类型 |
| list[].price | string | - | desc:商品最低价格 |
| list[].cycle | string | - | desc:商品最低周期 |
| list[].mode | string | - | desc:代理模式 |
| list[].client_level_name | string | - | desc:用户等级名称 |
| list[].stock_control | int | - | desc:是否开启库存 |
| list[].qty | int | - | desc:库存数量 |
| list[].pay_ontrial | object | - | desc:试用配置 |
| count | int | - | desc:商品总数 |
商品详情
| 项目 | 内容 |
|---|---|
| 接口描述 | 商品详情 |
| 接口地址 | /console/v1/product/:id |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:商品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| product | object | - | desc:商品 |
| product.id | int | - | desc:ID |
| product.name | string | - | desc:商品名称 |
| product.product_group_id | int | - | desc:所属商品组ID |
| product.description | string | - | desc:商品描述 |
| product.hidden | int | - | desc:0显示默认 |
| product.stock_control | int | - | desc:库存控制 |
| product.qty | int | - | desc:库存数量 |
| product.pay_type | int | - | desc:付款类型 |
| product.auto_setup | int | - | desc:是否自动开通 |
| product.type | int | - | desc:关联类型 |
| product.rel_id | int | - | desc:关联ID |
| upgrade | array | - | desc:可升降级商品ID |
| product_id | int | - | desc:父商品ID |
| plugin_custom_fields | array | - | desc:自定义字段{is_link是否已有子商品 |
| show | int | - | desc:是否将商品展示在会员中心对应模块的列表中 |
| on_demand.min_credit | string | - | desc:购买时用户最低余额 |
| on_demand.min_usage_time | int | - | desc:最低使用时长 |
| on_demand.min_usage_time_unit | string | - | desc:最低使用时长单位 |
| on_demand.credit_limit_pay | int | - | desc:允许信用额支付 |
结算商品
| 项目 | 内容 |
|---|---|
| 接口描述 | 结算商品 |
| 接口地址 | /console/v1/product/settle |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| product_id | int | - | validate:required | desc:商品ID |
| config_options | object | - | validate:required | desc:自定义配置 |
| customfield | object | - | 比如优惠码参数传{"promo_code":["pr8nRQOGbmv5"]}validate:optional | desc:自定义参数 |
| qty | int | - | validate:required | desc:数量 |
| self_defined_field | object | - | {"5":"123"}5是自定义字段ID123是填写的内容validate:optional | desc:自定义字段 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| order_id | int | - | desc:订单ID |
商品配置页面
| 项目 | 内容 |
|---|---|
| 接口描述 | 商品配置页面 |
| 接口地址 | /console/v1/product/:id/config_option |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:商品ID |
| flag | bool | - | true是false否validate:optional | desc:是否获取隐藏商品的模块内容 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| product_name | string | - | desc:商品名称 |
| content | string | - | desc:模块输出内容 |
修改配置计算价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改配置计算价格 |
| 接口地址 | /console/v1/product/:id/config_option |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:商品ID |
| qty | int | - | validate:required | desc:数量 |
| config_options | array | - | 格式{"configoption":{1:1,2:[2]},"cycle":2,"promo_code":"Af13S1ACj","event_promotion":12,"qty":1}validate:optional | desc:模块自定义配置参数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | desc:价格 |
| renew_price | string | - | desc:续费价格 |
| billing_cycle | string | - | desc:周期名称 |
| duration | int | - | desc:周期时长 |
| description | string | - | desc:订单子项描述 |
| base_price | string | - | desc:基础价格 |
| price_total | float | - | desc:折扣后金额 |
| price_promo_code_discount | float | - | desc:优惠码折扣金额 |
| price_client_level_discount | float | - | desc:客户等级折扣金额 |
| price_event_promotion_discount | float | - | desc:活动促销折扣金额 |
获取商品库存
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取商品库存 |
| 接口地址 | /console/v1/product/:id/stock |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:商品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| product | object | - | desc:商品 |
| product.id | int | - | desc:ID |
| product.stock_control | int | - | desc:库存控制 |
| product.qty | int | - | desc:库存数量 |
商品订单页自定义字段
| 项目 | 内容 |
|---|---|
| 接口描述 | 商品订单页自定义字段 |
| 接口地址 | /console/v1/product/:id/self_defined_field/order_page |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:商品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data[].id | int | - | desc:自定义字段ID |
| data[].field_name | string | - | desc:字段名称 |
| data[].field_type | string | - | desc:字段类型 |
| data[].description | string | - | desc:字段描述 |
| data[].regexpr | string | - | desc:验证规则 |
| data[].field_option | string | - | desc:下拉选项 |
| data[].is_required | int | - | desc:是否必填 |
| data[].show_client_host_list | int | - | desc:会员中心列表显示 |
| data[].explain_content | string | - | desc:说明内容 |