区域门店

_images/areastore.png

导入加盟商

在甩手掌柜平台上批量生成加盟商信息

接口名称

cmd = "ImportFranch"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string ImportFranch 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
items json list   详见下表

上面表格中的字段items对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
fullfraclassname string 加盟商|长沙地区 加盟商类型路径全名,格式:加盟商|长沙地区
extfrauid string 192 加盟商ID(第三方)
fracode string 5244 加盟商编码
franame string 萧炎 加盟商名称
zjm string XY 助记码
linkman string 萧炎 联系人
tel string 1897514255 联系电话
emial string 1897514255@1qq.com 电子邮箱
province string 湖南
city string 长沙
county string 开福区 区域
vcadd string 五一路西路29号 地址
state int 0 状态 -1 停用 0 正常
creditrisklevel int 0 信贷风险 0 高风险 1 低风险
remark string 多店加商盟 备注

注解

  • 加盟商为全量导入。加盟商类型为树形结构。同一级别下的加盟商类型不能重复。
  • 系统默认存在“加盟商”,以及“加盟商”下默认有1个“待分配加盟商”,待分配加盟商下不能建加盟商类型,也不能修改删除。
  • 在加盟商可以建下级加盟商,最多只能建3级,加盟商类型的层级中间用‘|’隔开”。
  • 加盟商编码为关键字,若出现编码重复时,编码相同的加盟商编码下次同步的信息将覆盖前面的信息,同步时不会提示失败。
  • 必填字段必须填写正确,否则同步失败。
  • 联系电话号码请确保格式正确,若为座机号码,必须要填写区号
  • 加盟商可多次导入,每次导入后,区域重新建立。对已存在的加盟商,再次导入时,首先将其设置成删除状态,并将其分配到“待分配加盟商”下,然后将本次导入的门店更新或插入到新加盟商下。

请求示例

{
  "cmd": "ImportAreaStore",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "areacode": "01.02.03",
      "fullareaname": "湖南|长沙|芙蓉区",
      "storecode": "001",
      "storename": "湘阴一店",
      "storetype": 0,
      "state": 1,
      "vcleader": "李四",
      "vctel": "13301200123",
      "email": "abc@163.com",
      "vcaddr": "湖南岳阳湘阴步行街12号",
      "remark": "接口新增"
    }
  ]
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,码解释见“全局返回码说明”
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
failitems list join   错误信息

上面表格中的字段failitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
failrow int 1 错误行号
failreason string 门店编码重复 错误为错误提示信息

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

导入区域门店

在甩手掌柜平台上批量生成门店信息

接口名称

cmd = "ImportAreaStore"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string ImportAreaStore 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
autodel integer 1 引用区域(门店)的相关表记录自动删除(0 不删除,报错退出;1 自动删除 )
items json list   详见下表

上面表格中的字段items对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
fullareaname string 湖南|长沙|芙蓉区 区域路径全名,格式:湖南|长沙|芙蓉区
extstoreuid string 192 门店id(第三方)
storecode string 001 门店编码,不允许重复
storename string 五一广场店 门店名称
zjm string WYGCD 助记码
storetype string 1 门店类型: 0 自营 1 合营 2 加盟 3 部门
state int 0 状态(0 启用、-1 删除、1 禁用),默认 0
vctype int 0 门店标识( 0 仓库,1 门店 ,3 网店)
fracode string 0101 加盟商编码
vcleader string 张三 店长姓名
vctel string 18673112310 联系电话
email string aa@weipos.com 联系邮箱
vcaddr string 湖南长沙五一路12号 门店详细地址
deforderware string 001 默认报货仓库(仓库编码)
retware string 002 默认退仓仓库(仓库编码)
province string 湖南 省份
city string 长沙
county string 雨花区
busstarttime string 8:00 营业开始时间
busendtime string 21:00 营业结束时间
longitude string   门店经度
latitude string   门店纬度
areasize integer   面积(平方)
ipercount integer   员工数量
storelicensetype string   营业执照类型【企业法人、个体工商】
storeremindtime string   年检提醒【6月30日前】
storechangedate string   换证日期【企业法人10年、个体工商4年】
remark string   备注信息

注解

  • 区域、门店为全量导入。区域为树形结构。同一级别下的区域名称不能重复。
  • 系统默认存在“区域”,以及“区域”下默认有1个“待分配区域”,待分配区域下不能建区域,也不能修改删除。
  • 在区域下可以建下级区域,最多只能建3级,区域的层级中间用‘|’隔开”。
  • 门店编码为关键字,若出现编码重复时,编码相同的门店下次同步的信息将覆盖前面的信息,同步时不会提示失败。
  • 必填字段必须填写正确,否则同步失败。
  • 联系电话号码请确保格式正确,若为座机号码,必须要填写区号
  • 区域门店可多次导入,每次导入后,区域重新建立。对已存在的门店,再次导入时,首先将其设置成删除状态,并将其分配到“待分配区域”下,然后将本次导入的门店更新或插入到新区域下。

请求示例

{
  "cmd": "ImportAreaStore",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "areacode": "01.02.03",
      "fullareaname": "湖南|长沙|芙蓉区",
      "storecode": "001",
      "storename": "湘阴一店",
      "storetype": 0,
      "state": 1,
      "vcleader": "李四",
      "vctel": "13301200123",
      "email": "abc@163.com",
      "vcaddr": "湖南岳阳湘阴步行街12号",
      "remark": "接口新增"
    }
  ]
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,码解释见“全局返回码说明”
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
failitems list join   错误信息

上面表格中的字段failitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
failrow int 1 错误行号
failreason string 门店编码重复 错误为错误提示信息

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

导入门店用户

在甩手掌柜平台上批量生成门店的用户信息

接口名称

cmd = "ImportStoreUser"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string ImportStoreUser 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
items json list    

上面表格中的字段items对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
empcode string 00101 员工编码,不允许重复
empname string 张三 员工名称
mobile string 18673112310 电话号码
pwd string 3CED 口令
rolename string 店长 角色名称(总部管理员、总部财务、总部仓管、总部运营、加盟商、店长、营业员)
storecodes string “001” 所属门店编码
remark string   备注信息

注解

  • 系统默认有7个缺省角色:总部管理员、总部财务、总部仓管、总部运营、加盟商、店长、营业员

请求示例

{
    "cmd":"ImportStoreUser",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "items":[
        {
            "empcode":"001",
            "empname":"李四",
            "mobile":"13800138000",
            "pwd":"3CEDE",
            "rolename":"店长",
            "storecodes":"001",
            "remark":"接口新增"
        }
    ]
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,码解释见“全局返回码说明”
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
failitems list join   错误信息

上面表格中的字段failitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
failrow int 1 错误行号
failreason string 门店编码重复 错误为错误提示信息

返回示例

{
    "code":0,
    "msg":"",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
}

查询区域门店

获取甩手掌柜平台上的门店信息

接口名称

cmd = "QueryAreaStoreInfo"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string QueryAreaStoreInfo 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
storetype int 1 门店类型:0–全部、1–自营、2–加盟、3–联营
vctype int 0 门店标识(0–全部、1–仓库,2– 门店默认,3–网店)

请求示例

{
  "cmd": "QueryAreaStoreInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "storetype": 1,
  "vctype": 0
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
items json list   返回的门店基本信息

上面表格中的字段items对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
areauid integer 201 区域id
areacode string 01.02.03 区域编码
areaname string 芙蓉区 区域名称
fullareaname string 湖南|长沙|芙蓉区 区域路径全名,格式:湖南|长沙|芙蓉区
parentuid integer 101 父区域ID
extstoreuid string 192 门店id(第三方)
storeuid integer 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
zjm string WDD 助记码
vcaddr string 长沙市五一广场88号 门店地址
vclinkman string 张东强 联系人
vctel string 13548122778 联系电话
storetype int 0 门店类型(1–自营、2–加盟、3–联营 )
vctype int 0 门店类型(1–仓库,2– 门店默认,3–网店)
extdeforderwareid integer   默认报货仓库(第三仓库id)
deforderwareid integer   默认报货仓库(仓库id)
deforderware string 001 默认报货仓库(仓库编码)
deforderwarename string 001 默认报货仓库(仓库名称)
extretwareid integer 002 默认退仓仓库(第三仓库id)
retwareid integer 002 默认退仓仓库(仓库id)
retware string 002 默认退仓仓库(仓库编码)
retwarename string 002 默认退仓仓库(仓库名称)
dluid int 34 配送线路ID
province string 湖南 省份
city string 长沙
county string 雨花区
busstarttime string 8:00 营业开始时间
busendtime string 21:00 营业结束时间
longitude string 80111.21 门店经度
latitude string 70121.12 门店纬度
areasize integer 20 面积(平方)
ipercount integer 2 员工数量
storelicensetype string 1 营业执照类型【企业法人、个体工商】
storeremindtime string 2022-07-31 年检提醒【6月30日前】
storechangedate string 2022-08-31 换证日期【企业法人10年、个体工商4年】

注解

  • 门店为全量查询,查询到的是正常在用的门店

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "items": [
    {
      "areauid": "201",
      "areacode": "01.02.03",
      "areaname": "芙蓉区",
      "fullareaname": "湖南|长沙|芙蓉区",
      "parentuid": "101",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "vcaddr": "长沙市五一广场88号",
      "vclinkman": "张东强",
      "vctel": "13548122778",
      "storetype": 0,
      "vctype": 0,
      "deforderware": 2,
      "dluid": 34
    }
  ]
}

查询区域信息

获取甩手掌柜平台上的区域信息

接口名称

cmd = "QueryAreaInfo"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string QueryAreaInfo 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID

请求示例

{
  "cmd": "QueryAreaInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
items json list   返回的区域基本信息

上面表格中的字段items对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
areauid int 201 区域id
areaname string 101 区域名称
zjm string 001 助记码
parentuid int 万达店 父ID(根结点为null)
state int 0 状态(-1删除,0正常)

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "items": [
    {
      "areauid": 201,
      "areaname": "小城区",
      "zjm": "xcq",
      "parentuid": 9,
      "state": 0
    }
  ]
}

查询门店信息

获取甩手掌柜平台上的门店信息

接口名称

cmd = "QueryStoreInfo"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string QueryStoreInfo 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
storetype int 1 门店类型:0–全部、1–自营、2–加盟、3–联营
vctype int 0 门店标识(0–全部、1–仓库,2– 门店默认,3–网店)

请求示例

{
  "cmd": "QueryStoreInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "storetype": 1,
  "vctype": 0
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
items json list   返回的门店基本信息

上面表格中的字段items对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
areauid string 201 区域id
areaname string 待分配区域 区域名称
extstoreuid string 192 门店id(第三方)
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
vcaddr string 长沙市五一广场88号 门店地址
vclinkman string 张东强 联系人
vctel string 13548122778 联系电话
storetype int 0 门店类型(1–自营、2–加盟、3–联营 )
vctype int 0 门店类型(1–仓库,2– 门店默认,3–网店)
deforderware integer 2 默认报货仓库
dluid integer 34 配送线路ID
state int 0 状态(0-正常,1-停用)

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "items": [
    {
      "areauid": 1,
      "areaname": "待分配区域",
      "storeuid": 772,
      "storecode": "0508",
      "storename": "勿删",
      "vcaddr": " ",
      "vclinkman": " ",
      "vctel": "13715151515",
      "storetype": 1,
      "vctype": 2,
      "deforderware": 12,
      "dluid": 21,
      "state": 1
    }
  ]
}

查询配送线路

获取甩手掌柜平台上的配送线路信息

接口名称

cmd = "QueryDluidInfo"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string QueryDluidInfo 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID

请求示例

{
  "cmd": "QueryDluidInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
dluiditems string 41 返回的线程基本信息

上面表格中的字段dluiditems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
dluid string 41 线路ID
dlname string A路线 线路名称
dlcode string 010 线路编码
dldescr string   制单线路说明
drivername BigDecimal 小刘 司机
tel string 13866666666 司机电话
driverno string 湘A5GY99 车牌号
opman string 李四 操作人
uptime string 2017-02-01 20:00:00 更新时间
createtime string 13866666666 建立时间

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "",
  "items": [
    {
      "dluid": "41",
      "dlname": "A路线",
      "dlcode": "10",
      "dldescr": "",
      "drivername": "小刘",
      "tel": "13866666666",
      "driverno": "湘A5GY99",
      "opman": "李四",
      "uptime": "2017-02-01 20:00",
      "createtime": "2017-02-01 20:00"
    },
    {
      "dluid": "42",
      "dlname": "B路线",
      "dlcode": "11",
      "dldescr": "",
      "drivername": "大刘",
      "tel": "13866666667",
      "driverno": "湘A5GY90",
      "opman": "李四",
      "uptime": "2017-02-01 20:00",
      "createtime": "2017-02-01 20:00"
    },
    {
      "dluid": 141,
      "dlname": "123",
      "dlcode": "123",
      "tel": "12341234123",
      "opman": "吴测试权限",
      "uptime": "2017-06-21 11:01:34",
      "createtime": "2017-06-21 11:01:19"
    }
  ]
}

查询供应商信息

获取甩手掌柜平台上的供应商信息信息

接口名称

cmd = "QueryCustTomInfo"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string QueryCustTomInfo 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID

请求示例

{
  "cmd": "QueryCustTomInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
custtomclassitems string 41 返回的供应商基本信息

上面表格中的字段custtomclassitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
customclassuid integer 101 类型ID
customclassname string 耗材 类型说明
custtomitems string   返回的供应商基本信息

上面表格中的字段custtomitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
custuid integer 41 供应商ID
custcode string 101 供应商编码名称
custname string 绿地包装 供应商名称
zjm string LDBZ 助记码
linkman string 周冬雨 联系人
tel string 135784148147 电话
email string 135784148147@mail.com 邮件地址
province string 湖南 地址(省)
city string 长沙 地址(市)
district string 开福区 地址(区)
addr string 湖南省长沙市开福区环保路40号 地址(详细地址)

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "",
  "custtomclassitems": [
    {
      "customclassuid": 101,
      "customclassname": "耗材",
      "custtomitems": [
        {
          "custuid": 41,
          "custcode": "101",
          "custname": "绿地包装",
          "zjm": "LDBZ",
          "linkman": "周冬雨",
          "tel": "135784148147",
          "email": "135784148147@mail.com",
          "province": "湖南",
          "city": "长沙",
          "district": "开福区",
          "addr": "湖南省长沙市开福区环保路40号"
        }
      ]
    }
  ]
}

查询加盟商信息

获取甩手掌柜平台上的供应商信息信息

接口名称

cmd = "QueryFranchInfo"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string QueryFranchInfo 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID

请求示例

{
  "cmd": "QueryFranchInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

返回参数

参数名 类型 是否必须 示例值 描述
code integer 0 返回状态码,详见
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
franchclassitems string 41 返回的加盟商基本信息

上面表格中的字段Franchclassitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
franchclassuid integer 101 类型ID
franchclassname string 耗材 类型说明
franchitems string   返回的加盟商基本信息

上面表格中的字段Franchitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
frauid integer 41 加盟商ID
extfrauid string 192 加盟商id(第三方)
fracode string 101 加盟商编码名称
franame string 绿地包装 加盟商名称
zjm string LDBZ 助记码
linkman string 周冬雨 联系人
tel string 135784148147 电话
email string 135784148147@mail.com 邮件地址
province string 湖南 地址(省)
city string 长沙 地址(市)
district string 开福区 地址(区)
addr string 湖南省长沙市开福区环保路40号 地址(详细地址)
storeitems     返回的加盟商门店信息

上面表格中的字段storeitems对应的值是个json数据,类型是列表,字段如下

参数名 类型 是否必须 示例值 描述
areauid integer 41 区或ID
areaname string 长沙 区域名称
extstoreuid string 192 门店id(第三方)
storeuid integer 1234 门店ID
storecode string 3564 门店编码
storename string 芙蓉区加盟商 门店名称

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "",
  "franchclassitems": [
    {
      "customclassuid": 101,
      "customclassname": "长沙加盟",
      "franchitems": [
        {
          "frauid": 41,
          "fracode": "101",
          "franame": "柳云龙",
          "zjm": "LDBZ",
          "linkman": "周冬雨",
          "tel": "135784148147",
          "email": "135784148147@mail.com",
          "province": "湖南",
          "city": "长沙",
          "district": "开福区",
          "addr": "湖南省长沙市开福区环保路40号",
           "storesitems": [
            {
              "areauid": 519,
              "areaname": "辽宁省",
              "storeuid": 38395,
              "storecode": "521818",
              "storename": "吴忠秀的店"
            },
            {
              "areauid": 521,
              "areaname": "长沙",
              "storeuid": 38390,
              "storecode": "1013",
              "storename": "hyt_store"
            }
          ],
        }
      ]
    }
  ]
}