Skip to content

商品管理 ​

获取商品一级分组 ​

项目内容
接口描述获取商品一级分组
接口地址/console/v1/product/group/first
请求方式GET
接口版本v1

请求参数

无

响应参数

nametypedefaultdesc
listarray-desc:商品一级分组
list[].idint-desc:商品一级分组ID
list[].nameint-desc:商品一级分组名称
list[].typeint-desc:分组类型
countint-desc:商品一级分组总数

获取商品二级分组 ​

项目内容
接口描述获取商品二级分组
接口地址/console/v1/product/group/second
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:optionaldesc:一级分组ID

响应参数

nametypedefaultdesc
listarray-desc:商品二级分组
list[].idint-desc:商品二级分组ID
list[].nameint-desc:商品二级分组名称
list[].parent_idint-desc:商品一级分组ID
list[].typeint-desc:分组类型
list[].descriptionstring-desc:描述
countint-desc:商品二级分组总数

商品列表 ​

项目内容
接口描述商品列表
接口地址/console/v1/product
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
keywordsstring-搜索范围商品ID商品名描述validate:optionaldesc:关键字
idint-validate:optionaldesc:二级分组ID
pageint-validate:optionaldesc:页数
limitint-validate:optionaldesc:每页条数
exclusivebool-validate:optionaldesc:是否只返回专属商品
product_idsarray-validate:optionaldesc:筛选哪些商品

响应参数

nametypedefaultdesc
listarray-desc:商品列表
list[].idint-desc:ID
list[].namestring-desc:商品名
list[].descriptionstring-desc:描述
list[].pay_typestring-desc:付款类型
list[].pricestring-desc:商品最低价格
list[].cyclestring-desc:商品最低周期
list[].modestring-desc:代理模式
list[].client_level_namestring-desc:用户等级名称
list[].stock_controlint-desc:是否开启库存
list[].qtyint-desc:库存数量
list[].pay_ontrialobject-desc:试用配置
countint-desc:商品总数

商品详情 ​

项目内容
接口描述商品详情
接口地址/console/v1/product/:id
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:商品ID

响应参数

nametypedefaultdesc
productobject-desc:商品
product.idint-desc:ID
product.namestring-desc:商品名称
product.product_group_idint-desc:所属商品组ID
product.descriptionstring-desc:商品描述
product.hiddenint-desc:0显示默认
product.stock_controlint-desc:库存控制
product.qtyint-desc:库存数量
product.pay_typeint-desc:付款类型
product.auto_setupint-desc:是否自动开通
product.typeint-desc:关联类型
product.rel_idint-desc:关联ID
upgradearray-desc:可升降级商品ID
product_idint-desc:父商品ID
plugin_custom_fieldsarray-desc:自定义字段{is_link是否已有子商品
showint-desc:是否将商品展示在会员中心对应模块的列表中
on_demand.min_creditstring-desc:购买时用户最低余额
on_demand.min_usage_timeint-desc:最低使用时长
on_demand.min_usage_time_unitstring-desc:最低使用时长单位
on_demand.credit_limit_payint-desc:允许信用额支付

结算商品 ​

项目内容
接口描述结算商品
接口地址/console/v1/product/settle
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
product_idint-validate:requireddesc:商品ID
config_optionsobject-validate:requireddesc:自定义配置
customfieldobject-比如优惠码参数传{"promo_code":["pr8nRQOGbmv5"]}validate:optionaldesc:自定义参数
qtyint-validate:requireddesc:数量
self_defined_fieldobject-{"5":"123"}5是自定义字段ID123是填写的内容validate:optionaldesc:自定义字段

响应参数

nametypedefaultdesc
order_idint-desc:订单ID

商品配置页面 ​

项目内容
接口描述商品配置页面
接口地址/console/v1/product/:id/config_option
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:商品ID
flagbool-true是false否validate:optionaldesc:是否获取隐藏商品的模块内容

响应参数

nametypedefaultdesc
product_namestring-desc:商品名称
contentstring-desc:模块输出内容

修改配置计算价格 ​

项目内容
接口描述修改配置计算价格
接口地址/console/v1/product/:id/config_option
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:商品ID
qtyint-validate:requireddesc:数量
config_optionsarray-格式{"configoption":{1:1,2:[2]},"cycle":2,"promo_code":"Af13S1ACj","event_promotion":12,"qty":1}validate:optionaldesc:模块自定义配置参数

响应参数

nametypedefaultdesc
pricestring-desc:价格
renew_pricestring-desc:续费价格
billing_cyclestring-desc:周期名称
durationint-desc:周期时长
descriptionstring-desc:订单子项描述
base_pricestring-desc:基础价格
price_totalfloat-desc:折扣后金额
price_promo_code_discountfloat-desc:优惠码折扣金额
price_client_level_discountfloat-desc:客户等级折扣金额
price_event_promotion_discountfloat-desc:活动促销折扣金额

获取商品库存 ​

项目内容
接口描述获取商品库存
接口地址/console/v1/product/:id/stock
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:商品ID

响应参数

nametypedefaultdesc
productobject-desc:商品
product.idint-desc:ID
product.stock_controlint-desc:库存控制
product.qtyint-desc:库存数量

商品订单页自定义字段 ​

项目内容
接口描述商品订单页自定义字段
接口地址/console/v1/product/:id/self_defined_field/order_page
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:商品ID

响应参数

nametypedefaultdesc
data[].idint-desc:自定义字段ID
data[].field_namestring-desc:字段名称
data[].field_typestring-desc:字段类型
data[].descriptionstring-desc:字段描述
data[].regexprstring-desc:验证规则
data[].field_optionstring-desc:下拉选项
data[].is_requiredint-desc:是否必填
data[].show_client_host_listint-desc:会员中心列表显示
data[].explain_contentstring-desc:说明内容