企迈云-开放平台

API 2.0

API 2.0 > 3.4 商品分类 > 3.4.2 获取分类详情

3.4.2 获取分类详情

开启令牌和权限后可调用。签名方式请查看开发指南

场景描述：通过分类编码，获取当前店铺下的分类基本信息

餐饮平台零售平台餐饮

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	goods-category.goods-category-detail	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
group_sign	string	是		分类编码

响应参数

参数	参数类型	描述
id	int	分类ID
store_id	int	店铺ID
name	string	分类名称
sort	int	分类排序数字越小越靠前
seo_keywords	string	seo
seo_description	string	seo
status	int	状态
icon	string	图标图片地址
type	int	类型 1 堂食 2 外卖 3 外卖堂食
url	string	url
start_time	string	售卖开始时间
end_time	string	售卖结束时间
show_period	int	上架时间 0- 全时段展示 1- 自定义时段
real_icon	string	图片云地址
type_text	string	类型说明
period	array
├weeks	string	售卖时间段
├sign	string	分类编码

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "goods-category.goods-category-detail",
    "Params": {
        "group_sign": "10001"
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "id": "10001",
        "store_id": "20003",
        "name": "小炒",
        "sort": "100",
        "seo_keywords": "",
        "seo_description": "",
        "status": "1",
        "icon": "",
        "type": "3",
        "url": "",
        "start_time": "00:00:00",
        "end_time": "23:59:59",
        "show_period": "0",
        "real_icon": "",
        "type_text": "堂食\/外卖",
        "period": {
            "weeks": "",
            "sign": ""
        }
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	goods-category.goods-category-detail	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
id	int	是		分类id

响应参数

参数	参数类型	描述
id	int	分类ID
name	string	分类名称
sort	int	分类排序数字越小越靠前
pid	int	分类父id （默认是0）

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "goods-category.goods-category-detail",
    "Params": {
        "id": "2155"
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "id": "10001",
        "name": "小炒",
        "sort": "100",
        "pid": "0"
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	goods-category.goods-category-detail	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
id	int	是		分类id

响应参数

参数	参数类型	描述
id	int	分类ID
name	string	分类名称
sort	int	分类排序数字越小越靠前
pid	int	分类父id （默认是0）

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "goods-category.goods-category-detail",
    "Params": {
        "id": "2155"
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "id": "10001",
        "name": "小炒",
        "sort": "100",
        "pid": "0"
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}