店铺-B2C-经营概览
概览 - 获取 B2C 店铺数据概览
接口信息
- 接口地址:
{your-site-url}/api/skill/overview/b2c-shop
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- 说明: 此接口用于获取 B2C 店铺的数据概览,包含商品、顾客、订单等核心统计数据和店铺基本信息。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数
无参数。
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/overview/b2c-shop' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"product_count": 475,
"customer_count": 490,
"order_count": {
"fulfill_order_count": 1672,
"pending_order_count": 2003,
"fulfilled_order_count": 40
},
"b2c_inquire_count": 73,
"shop_name": " fec测试店铺-frist",
"shop_type": 10,
"shop_status": 1,
"shop_manager_status": 1,
"shop_product_max_count": 0,
"shop_info": {
"package_name": "my package\r\n",
"package_id": 5,
"pay_type": 1,
"product_max_count": 0,
"is_not_expire": 1,
"expired_at": 0,
"manager_status": 1
}
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
店铺概览数据 |
data 字段
| 字段 |
类型 |
说明 |
product_count |
int |
店铺商品总个数 |
customer_count |
int |
店铺顾客总个数 |
order_count.fulfill_order_count |
int |
待发货订单个数 |
order_count.pending_order_count |
int |
未支付订单总个数 |
order_count.fulfilled_order_count |
int |
已发货订单个数 |
b2c_inquire_count |
int |
询盘总个数 |
shop_name |
string |
店铺名称 |
shop_type |
int |
店铺类型。10 = B2C 独立站,20 = B2B 店铺 |
shop_status |
int |
店铺状态。1 = 开启,2 = 关闭。关闭后商城前台和商家端后台均无法访问 |
shop_manager_status |
int |
商家端后台设置的店铺管理状态。1 = 开启,2 = 关闭。关闭后前台商城无法访问,但商家端后台可访问 |
shop_product_max_count |
int |
最大可创建商品数。0 = 无限制 |
shop_info |
Object |
店铺套餐及付费信息 |
shop_info 字段
| 字段 |
类型 |
说明 |
package_name |
string |
店铺套餐名称 |
package_id |
int |
套餐 ID |
pay_type |
int |
店铺支付类型。1 = 正常店铺,2 = 体验店铺 |
product_max_count |
int |
套餐限制的最大商品数。0 = 无限制 |
is_not_expire |
int |
是否永不过期。1 = 永不过期,2 = 按 expired_at 决定过期 |
expired_at |
int |
过期时间。0 表示不过期或永不过期 |
manager_status |
int |
套餐管理状态。1 = 开启 |
注意事项
shop_status 关闭后商家端后台也无法访问(彻底关闭)
shop_manager_status 关闭后仅前台不可访问,商家端仍可登录管理(类似"打烊")
shop_type = 10 为 B2C 店铺,20 为 B2B 店铺
shop_product_max_count 是套餐内商品上限与店铺实际设置的综合结果
- 在调用前,需要先通过:获取店铺基本信息 得到店铺类型,如果店铺类型是B2C,则调用本api