店铺数据

接口说明

二维火提供商户数据接口,第三方系统可通过此接口获取商户数据

二维火商户和第三方系统商户进行id匹配;

接口定义

请求URL:

http://{servename}/router(二维火提供查询)

1、查询绑定店铺列表

method="dfire.shop.list"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.shop.list

返回参数为:

字段说明 字段名 类型 可空(Y/N) 默认值
店铺信息 ShopVo Object N  
[ShopVo]店铺结构
字段说明 字段名 类型 可空(Y/N) 默认值
店铺Id entityId String N  
店铺名称 name String N  
店铺编码 code String N  
联系方式 mobile String Y  
联系人 linkman String Y  
联系地址 address String Y  
邮件 email String Y  
行业 industry Integer N 0:餐饮 1:零售
店铺类型 shopKind Integer N 1.中餐 2.西餐 3.火锅 4.服鞋 5.便利店,超市 6.五金 101.零售服鞋 102.零售商超
总部ID brandEntityId String Y 为空,代表单店,无总部
品牌ID plateEntityId String Y 为空,代表单店,无品牌
营业时间 businessTime String Y  
开店时间 createTime String N  
加盟类型 joinMode Integer N 0加盟 1直营 2合作 3合营
经度 longtitude Double N  
纬度 latitude Double N  
省Id provinceId String N  
城市Id cityId String N  
乡镇Id townId String N  
是否测试店 isTest Integer N 0 正式 1 测试
特色标签 specialTag String Y  
人均消费 avgPrice String Y  

返回参数 实例:


{

“success”: true,

“model”: [

{

“brandEntityId”: “00128763”,

“entityId”: “00031469”,

“name”: “吴佳星”,

“code”: “106221”,

“address”: “上海 上海市 浦东新区 张江高科技园区XXX路XXX号2号楼”,

“createTime”: “1439891855”,

“industry”: 0,

“shopKind”: 0,

“customerkind”: 2,

“joinMode”: 1,

“shopType”: 0,

“longtitude”: 0.0,

“latitude”: 0.0,

“provinceId”: “9”,

“city”: “上海市”,

“cityId”: “3”,

“townId”: “31”,

“type”: “shop”,

“isTest”: 0

},

“totalRecord”: 0

}


2、根据连锁店铺ID获取品牌信息

method="dfire.shop.plate.data"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例
连锁id entityId String N 所属连锁

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.shop.plate.data
entityId:99929155

返回参数为:

字段说明 字段名 类型 可空(Y/N) 默认值
品牌Id entityId String N  
拼音 spell String N  
品牌名 name String N  

返回参数 实例:


{

“success”: true,

“model”: [

{

“name”: “品牌1”,

“spell”: “plate”,

“entityId”: “99104454”

}

],

“totalRecord”: 0

}


3、查询商铺的单个菜品信息

method="dfire.single.menu.query"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例
店铺id entityId String N  
菜品id itemId String N  

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.single.menu.query
itemId:990011255398d1a201539c4eb47b000b
entityId:99929155

Response返回:

[DishVo]菜品结构:
字段名 类型 可空(Y/N) 字段说明
id String N 菜品id
entityId String N 店铺id
name String N 菜品名
unit String Y 点菜单位,默认为份
account String Y 结账单位
price int N 单价,单位分
kindId String N 菜品分类id
isTakeout int N 是否外卖可点 0/不可点 1/可点
soldOut boolean N 是否售罄 false/没售罄 true/已售罄
reserve int N 是否堂食可点 0/不可点 1/可点
pic String Y 菜品图片地址
memo String Y 菜品描述
sort int Y 顺序码
hot int Y 辣度
isInclude int N 0/普通菜类;1/套菜;2/配料
dishMakeVoList Array<DishMakeVo> N 做法
dishSpecVoList Array<DishSpecVo> N 规格
suitDishGroupVoList Array<SuitDishGroupVo> N 套餐中的菜品组
[DishMakeVo]菜品做法结构
字段名 类型 可空(Y/N) 字段说明
name String N 做法名称
makeId String N 做法id
makePrice int N 做法加价
makePriceMode int N 调价模式: 0/不加价; 1/一次性加价; 2/每点菜单位加价; 3/每结账单位加价
[DishSpecVo]菜品规格结构
字段名 类型 可空(Y/N) 字段说明
name String N 规格名称
specItemId String N 规格id
priceMode int N 加价模式: 0/不加价; 1/一次性加价; 2/每点菜单位加价; 3/每结账单位加价
menuPrice int N 菜肴价格
priceScale double N 价格调整比例: 1/商品根据规格倍数自动算价格; 2/自定义商品价格,不按规格倍数走
[SuitDishGroupVo]套菜中的菜品组结构
字段名 类型 可空(Y/N) 字段说明
entityId String N 店铺id
num String N 数量
isRequired int N 套菜子菜属性 1:必选 0:备选
isChange int N 0:不可换 1:可换
changeMode double N 可换菜的备选范围包括: 1:从可换菜中换 2:从菜肴库中换 3:以上两者均可
name String N 菜品组的名称
menuPrice int N 菜肴价格
dishChangeVoList Array<DishChangeVo> Y 套餐菜品组中的子菜
[DishChangeVo]套菜菜品组的子菜结构
字段名 类型 可空(Y/N) 字段说明
menuId String N 菜品id
menuName String N 菜品名称
menuPrice int N 菜品价格
specDetailName String N 规格名称
isRequired int N 套菜子菜属性 1:必选 0:备选
num double N 数量
priceMode int N 加价模式: 0/不加价; 1/一次性加价; 2/每点菜单位加价; 3/每结账单位加价
price int N 加价
specDetailId String Y 规格id
dishMakeVoList Array<DishMakeVo> Y 做法
dishSpecVoList Array<DishSpecVo> Y 规格

返回结果 实例:

{
    "success": true,
    "model": {
        "id": "999302895a5a83f2015a68dffdf10047",
        "entityId": "99930289",
        "name": "中式午餐套餐二",
        "price": 1,
        "isTakeout": 0,
        "soldOut": false,
        "reserve": 1,
        "sort": 0,
        "hot": 0,
        "isInclude": 1,
        "suitDishGroupVoList": [
            {
                "entityId": "99930289",
                "num": 0,
                "isRequired": 1,
                "isChange": 0,
                "changeMode": 1,
                "name": "桃园",
                "menuPrice": 1900,
                "dishChangeVoList": [
                    {
                        "menuId": "999302895a5a83f2015a5f68f5f7000e",
                        "menuName": "农家小炒肉",
                        "menuPrice": 8800,
                        "isRequired": 0,
                        "num": 1,
                        "priceMode": 0,
                        "price": 0
                    }
                ]
            },
            {
                "entityId": "99930289",
                "num": 1,
                "isRequired": 1,
                "isChange": 0,
                "changeMode": 1,
                "menuPrice": 1,
                "dishChangeVoList": [
                    {
                        "menuId": "999302895a5a8ec7015a5f68f9290017",
                        "menuName": "牛奶",
                        "menuPrice": 1,
                        "isRequired": 0,
                        "num": 1,
                        "priceMode": 0,
                        "price": 0,
                        "dishMakeVoList": [
                            {
                                "makeId": "999302895c1a4d07015c2f0956eb0061",
                                "makePrice": 0,
                                "makePriceMode": 0
                            },
                            {
                                "makeId": "999302895a5a8ec7015a5ff5d0640027",
                                "makePrice": 0,
                                "makePriceMode": 0
                            }
                        ],
                        "dishSpecVoList": [
                            {
                                "specItemId": "999302895a5a83f2015a5ff4ba6a0021",
                                "priceMode": 2,
                                "menuPrice": 0,
                                "priceScale": 0
                            },
                            {
                                "specItemId": "999302895c1a4d07015c2f0993220063",
                                "priceMode": 2,
                                "menuPrice": 0,
                                "priceScale": 0
                            }
                        ]
                    },
                    {
                        "menuId": "999302895a5a8ec7015a5f68f8a00016",
                        "menuName": "橙汁",
                        "menuPrice": 1200,
                        "isRequired": 0,
                        "num": 1,
                        "priceMode": 0,
                        "price": 0,
                        "specDetailId": "999302895a5a83f2015a5ff4ba6a0021",
                        "dishMakeVoList": [
                            {
                                "makeId": "999302895a5a8ec7015a5ff5d0640027",
                                "makePrice": 300,
                                "makePriceMode": 1
                            }
                        ],
                        "dishSpecVoList": [
                            {
                                "specItemId": "999302895a5a83f2015a5ff4ba6a0021",
                                "priceMode": 2,
                                "menuPrice": 0,
                                "priceScale": 6
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "totalRecord": 0
}

4、查询商铺所有的菜品信息

method="dfire.total.menu.query"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例
店铺id entityId String N  

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.total.menu.query
entityId:99929155

Response返回:

List<DishVo> 菜品列表结构:

返回结果 实例:

{
    "success": true,
    "model": [
        {
            "id": "999302895a5a83f2015a731093c200fe",
            "entityId": "99930289",
            "name": "王老吉",
            "price": 1000,
            "isTakeout": 0,
            "soldOut": false,
            "reserve": 1,
            "sort": 1,
            "hot": 0,
            "isInclude": 0
        },
        {
            "id": "999302895a5a8ec7015a5f68f9290017",
            "entityId": "99930289",
            "name": "牛奶",
            "price": 1,
            "isTakeout": 0,
            "soldOut": false,
            "reserve": 1,
            "sort": 0,
            "hot": 0,
            "isInclude": 0,
            "dishMakeVoList": [
                {
                    "makeId": "999302895c1a4d07015c2f0956eb0061",
                    "makePrice": 0,
                    "makePriceMode": 0
                },
                {
                    "makeId": "999302895a5a8ec7015a5ff5d0640027",
                    "makePrice": 0,
                    "makePriceMode": 0
                }
            ],
            "dishSpecVoList": [
                {
                    "specItemId": "999302895a5a83f2015a5ff4ba6a0021",
                    "priceMode": 2,
                    "menuPrice": 0,
                    "priceScale": 0
                },
                {
                    "specItemId": "999302895c1a4d07015c2f0993220063",
                    "priceMode": 2,
                    "menuPrice": 0,
                    "priceScale": 0
                }
            ]
        },
        {
            "id": "999302895a5a83f2015a68dffdf10047",
            "entityId": "99930289",
            "name": "中式午餐套餐二",
            "price": 1,
            "isTakeout": 0,
            "soldOut": false,
            "reserve": 1,
            "sort": 0,
            "hot": 0,
            "isInclude": 1,
            "suitDishGroupVoList": [
                {
                    "entityId": "99930289",
                    "num": 1,
                    "isRequired": 1,
                    "isChange": 0,
                    "changeMode": 1,
                    "menuPrice": 0,
                    "dishChangeVoList": [
                        {
                            "menuId": "999302895a5a8ec7015a5f68f9290017",
                            "menuName": "牛奶",
                            "menuPrice": 1,
                            "isRequired": 0,
                            "num": 1,
                            "priceMode": 0,
                            "price": 0,
                            "dishMakeVoList": [
                                {
                                    "makeId": "999302895c1a4d07015c2f0956eb0061",
                                    "makePrice": 0,
                                    "makePriceMode": 0
                                },
                                {
                                    "makeId": "999302895a5a8ec7015a5ff5d0640027",
                                    "makePrice": 0,
                                    "makePriceMode": 0
                                }
                            ],
                            "dishSpecVoList": [
                                {
                                    "specItemId": "999302895a5a83f2015a5ff4ba6a0021",
                                    "priceMode": 2,
                                    "menuPrice": 0,
                                    "priceScale": 0
                                },
                                {
                                    "specItemId": "999302895c1a4d07015c2f0993220063",
                                    "priceMode": 2,
                                    "menuPrice": 0,
                                    "priceScale": 0
                                }
                            ]
                        },
                        {
                            "menuId": "999302895a5a8ec7015a5f68f8a00016",
                            "menuName": "橙汁",
                            "menuPrice": 1200,
                            "isRequired": 0,
                            "num": 1,
                            "priceMode": 0,
                            "price": 0,
                            "specDetailId": "999302895a5a83f2015a5ff4ba6a0021",
                            "dishMakeVoList": [
                                {
                                    "makeId": "999302895a5a8ec7015a5ff5d0640027",
                                    "makePrice": 300,
                                    "makePriceMode": 1
                                }
                            ],
                            "dishSpecVoList": [
                                {
                                    "specItemId": "999302895a5a83f2015a5ff4ba6a0021",
                                    "priceMode": 2,
                                    "menuPrice": 0,
                                    "priceScale": 6
                                }
                            ]
                        }
                    ]
                },
                {
                    "entityId": "99930289",
                    "num": 1,
                    "isRequired": 1,
                    "isChange": 1,
                    "changeMode": 1,
                    "menuPrice": 0
                },
                {
                    "entityId": "99930289",
                    "num": 0,
                    "isRequired": 1,
                    "isChange": 0,
                    "changeMode": 1,
                    "name": "桃园",
                    "menuPrice": 0,
                    "dishChangeVoList": [
                        {
                            "menuId": "999302895a5a83f2015a5f68f5f7000e",
                            "menuName": "农家小炒肉",
                            "menuPrice": 8800,
                            "isRequired": 0,
                            "num": 1,
                            "priceMode": 0,
                            "price": 0
                        }
                    ]
                }
            ]
        }
    ],
    "totalRecord": 0
}

5、查询店铺经营执照信息

method="dfire.shop.qualification.data"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例
店铺entityId entityId String N  

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.shop.qualification.data
entityId:99929155
字段说明 字段名 类型 可空(Y/N) 默认值
店铺执照信息 Qualification Object N  
[Qualification]店铺执照信息结构
字段说明 字段名 类型 可空(Y/N) 说明
店铺ID entityId String N  
营业执照名称 licenseName String Y  
营业执照注册地址 licenseAddress String Y  
营业执照注册资金 registerFund double N  
注册编号 registerNum String Y  
注册登记机关 registerAuthority String Y  
注册日期 registerDate Integer N 秒级时间戳
营业执照有效期开始日期 validityStartDate Integer N 秒级时间戳
营业执照有效期结束日期 validityEndDaten Integer N 秒级时间戳
组织机构代码 organizationCode String Y  
组织机构类型 organizationType String Y  
开票名称 invoiceName String Y  
统一社会信用代码 creditCode String Y  
税务登记证号 taxRegisterNum String Y  
税务登记注册类型 taxRegisterType String Y  
增值税一般纳税人姓名 generalTaxpayer String Y  

返回参数 实例:


{

“success”: true,

“model”: {

“id”: “25c2e01cc96c471fb954d7719c5fa2e7”,

“lastVer”: 0,

“isValid”: 1,

“opTime”: 1509933122,

“createTime”: 1509933122,

“entityId”: “00069682”,

“licenseName”: “好烦好烦好的”,

“registerFund”: 0.0,

“registerDate”: 0,

“validityStartDate”: 0,

“validityEndDate”: 0,

“creditCode”: “123456789012345”

},

“totalRecord”: 0

}


6、查询店铺实体运营信息

method="dfire.shop.manager.data"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例
店铺entityId entityId String N  

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.shop.manager.data
entityId:99929155
字段说明 字段名 类型 可空(Y/N) 默认值
店铺运营信息 EntityManagerVo Object N  
[EntityManagerVo]店铺运营信息结构
字段说明 字段名 类型 可空(Y/N) 说明
销售来源 saleKind Integer N 店家来源 (0-无 1-直销 2-线上 3-渠道 4-合作商 5-其他 6-线上转直销 7-硬件厂商 8-自购 9 火伙伴 10试用 11饿了么 12支付宝口碑)
销售大区 region Integer N 大区编码
销售人员 saler String Y 花名
代理商 agent Integer N 代表销售公司信息:260温州迪火,250贵州天龙技术,166筷子科技,161佛山陈伟腾,198哈尔滨李洋等
渠道经理 channel String Y 花名
结算类型 payType Integer N 1先付款2后付款
店家等级 level Integer N A+-1,A-2,B-3,C-4,D-5,无-6
店家规模 scale Integer N 9-无,1-单店,2-当城市连锁,5-多城市连锁,3-全国连锁,4-超级KA-4,一级KA-6,二级KA-7,三级KA-8
维护费类型 mteType Integer N 维护费类型:不收费1、按年收费2、单次收费

返回参数 实例:


{

“success”: true,

“model”: {

“saleKind”: 5,

“region”: 0,

“saler”: “唐僧”,

“agent”: 0,

“payType”: 0,

“level”: 0,

“scale”: 0,

“mteType”: 1

},

“totalRecord”: 0

}


7、查询店铺法人联系信息

method="dfire.shop.corporation.data"

传递参数为:

字段说明 字段名 类型 可空(Y/N) 举例
店铺entityId entityId String N  

传递form表单参数实例:

appKey:cdc08577b61942442aa89390dacb25ad
timestamp:1476255107097
sign:DF0719FCD2B0CE188307595BB39F5DE9488DD57E
v:1.0
method:dfire.shop.corporation.data
entityId:99929155
字段说明 字段名 类型 可空(Y/N) 默认值
店铺法人信息 Corporation Object N  
[Corporation]店铺法人信息结构
字段说明 字段名 类型 可空(Y/N) 说明
店铺ID entityId String N  
法人姓名 name String N  
法人联系电话 linkTel String Y  
法人邮箱地址 email String Y  
法人QQ号码 qq String Y  
法人微信号 weChat String Y  
法人证件类型 certificateType Integer Y  
法人证件编号 certificateNum String Y  
证件有效期开始日期 validityStartDate Integer N 秒级时间戳
证件有效期结束日期 validityEndDate Integer N 秒级时间戳

返回参数 实例:


{

“success”: true,

“model”: {

“id”: “2b3e3b4d58b14ca5837d2a271137d052”,

“lastVer”: 0,

“isValid”: 1,

“opTime”: 1509933122,

“createTime”: 1509933122,

“entityId”: “00069682”,

“name”: “解决”,

“linkTel”: “182xxxxxxxx”,

“certificateType”: 1,

“certificateNum”: “55555555555”,

“validityStartDate”: 0,

“validityEndDate”: 0

},

“totalRecord”: 0

}