版权所有©，上海海鼎信息工程股份有限公司，2016-2025，保留所有权利。

接口

1. 接口定义

1.1. 仓库服务

1.1.1. 批量修改或保存仓库

POST /{tenant_id}/merchant/warehouseservice/warehouse/updates
1.1.1.1. 说明

批量修改或保存仓库

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

warehouses
必填

仓库列表

WarehouseList
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.1.4. HTTP请求示例
请求 path
/string/merchant/warehouseservice/warehouse/updates?operator=string
请求 body
{
  "warehouses" : [ {
    "code" : "00001",
    "name" : "广州仓",
    "gid" : "gid",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "phone" : "string"
    },
    "logistics_center_id" : "00001",
    "logistics_center_name" : "广州物流中行"
  } ]
}
1.1.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2. 门店服务

1.2.1. 创建门店信息

POST /{tenant_id}/merchant/storeservice/store
1.2.1.1. 说明

创建门店信息

1.2.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

store
必填

门店对象

Store
1.2.1.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.2.1.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store?operator=string
请求 body
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

1.2.2. 查找指定租户的门店

GET /{tenant_id}/merchant/storeservice/store
1.2.2.1. 说明

查找指定租户的门店

1.2.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

id
必填

门店ID

string
1.2.2.3. 响应
HTTP代码 说明 类型

200

successful operation

Store
1.2.2.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store?id=string
1.2.2.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

1.2.3. 修改门店信息

POST /{tenant_id}/merchant/storeservice/store/{id}
1.2.3.1. 说明

修改门店信息

1.2.3.2. 参数
类型 名称 说明 类型

Path

id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

mod
必填

修改信息

StoreModification
1.2.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.3.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store/string?operator=string
请求 body
{
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "circles" : [ "string" ],
  "gid" : "string",
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "sap_code" : "string",
  "business_hours" : "08:00-10:00;12:00-14:00",
  "source_sys" : "HDPOS4",
  "business_type" : "early_education",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}
1.2.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2.4. 查询单个门店详情

GET /{tenant_id}/merchant/storeservice/store/{id}
1.2.4.1. 说明

查询单个门店详情

1.2.4.2. 参数
类型 名称 说明 类型

Path

id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string
1.2.4.3. 响应
HTTP代码 说明 类型

200

successful operation

Store
1.2.4.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store/string
1.2.4.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

1.2.5. 批量获得门店信息

GET /{tenant_id}/merchant/storeservice/stores
1.2.5.1. 说明

批量获得门店信息

1.2.5.2. 参数
类型 名称 说明 类型

Query

id
必填

门店ID集合

< string > array(multi)

Query

org_id
必填

企业ID

string
1.2.5.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
1.2.5.4. HTTP请求示例
请求 path
/{tenant_id}/merchant/storeservice/stores?id=string&org_id=string
1.2.5.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.2.6. 定位附近的门店

GET /{tenant_id}/merchant/storeservice/stores/location
1.2.6.1. 说明

定位附近的门店

1.2.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

count
可选

附近门店数量， null 为空默认查询30家

integer (int32)

Query

lat
必填

纬度

number

Query

lng
必填

经度

number
1.2.6.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
1.2.6.4. HTTP请求示例
请求 path
/string/merchant/storeservice/stores/location?lat=0.0&lng=0.0
1.2.6.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.2.7. 分页查询门店

POST /{tenant_id}/merchant/storeservice/stores/query
1.2.7.1. 说明

分页查询门店

1.2.7.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

查询过滤器

StoreFilter
1.2.7.3. 响应
HTTP代码 说明 类型

200

successful operation

StorePaging
1.2.7.4. HTTP请求示例
请求 path
/string/merchant/storeservice/stores/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "1323230",
  "states" : "opened",
  "types" : "self",
  "circles" : [ "string" ],
  "store_ids" : [ "string" ],
  "business_types" : [ "string" ],
  "key_like" : "2134",
  "latitude_start" : 65.0,
  "latitude_end" : 89.0,
  "longtitude_start" : 110.0,
  "longtitude_end" : 120.0,
  "modified_start" : "2018-09-07 00:00:00",
  "modified_end" : "2018-09-07 00:00:00"
}
1.2.7.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.2.8. 同步门店信息

POST /{tenant_id}/merchant/storeservice/updates
1.2.8.1. 说明

同步门店信息

1.2.8.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

stores
必填

门店列表

StoreList
1.2.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.8.4. HTTP请求示例
请求 path
/string/merchant/storeservice/updates?operator=string
请求 body
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
1.2.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2.9. 获取用户授权门店

GET /{tenant_id}/merchant/storeservice/user/{user_id}/managestores
1.2.9.1. 说明

获取用户授权门店

1.2.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

user_id
必填

用户ID

string
1.2.9.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
1.2.9.4. HTTP请求示例
请求 path
/string/merchant/storeservice/user/string/managestores
1.2.9.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.2.10. 同步门店信息

POST /{tenant_id}/merchant/{tenant_id}/merchant/storeservice/syncStores
1.2.10.1. 说明

同步门店信息

1.2.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

stores
必填

门店列表

StoreList
1.2.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.10.4. HTTP请求示例
请求 path
/string/merchant/string/merchant/storeservice/syncStores?operator=string
请求 body
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
1.2.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. Contact

联系方式

名称 说明 类型

name
可选

联系人名称
样例 : "李飞"

string

phone
可选

电话
样例 : "18676778787"

string

2.3. CustomField

自定义属性值

名称 说明 类型

id
可选

字段ID
样例 : "area_id"

string

name
可选

自定名称
样例 : "地区代码"

string

value
可选

字段值
样例 : "ET09"

string

2.4. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.5. Location

位置信息

名称 说明 类型

area
可选

地区
样例 : "北区"

string

city
可选

市
样例 : "厦门"

string

city_code
可选

市代码
样例 : "01"

string

district
可选

区
样例 : "湖里"

string

district_code
可选

区代码
样例 : "13"

string

lat
可选

纬度
样例 : 123.0

number

lng
可选

经度
样例 : 64.0

number

province
可选

省
样例 : "福建"

string

province_code
可选

省代码
样例 : "365"

string

street
可选

详细地址
样例 : "金山街道226"

string

2.6. Store

门店资料对象

名称 说明 类型

account_name
可选

开票银行名称
样例 : "1245"

string

account_no
可选

开票银行账号
样例 : "1245"

string

area_leader
可选

区域主管
样例 : IdName

IdName

business_hours
可选

经营时段
样例 : "10:00-12:00;14:00-21:00"

string

business_type
可选

业态：ip（ip），park（乐园），early_education（早教）
样例 : "early_education"

string

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

contact
可选

联系方式
样例 : Contact

Contact

customs_fields
可选

自定义属性值
样例 : [ "CustomField" ]

< CustomField > array

distance
可选

距离
样例 : 100.0

number

gid
可选

门店Gid
样例 : "gid"

string

id
必填

门店代码
样例 : "2345456"

string

image_urls
可选

多张图片；分隔,最多5张图片
样例 : [ "string" ]

< string > array

location
可选

位置信息
样例 : Location

Location

main_image_url
可选

主图
样例 : "string"

string

name
必填

门店名称
样例 : "阳光店"

string

open_date
可选

开店时间
样例 : "2018-06-01 00:00:00"

string (date-time)

operation_manager
可选

运营经理
样例 : IdName

IdName

region
可选

所属区域
样例 : StoreRegion

StoreRegion

remark
可选

备注
样例 : "第二个路口左转"

string

sap_code
可选

门店SAP编码
样例 : "sapCode"

string

source_sys
可选

来源系统
样例 : "HDPOS4"

string

state
可选

门店状态：opened（正常），stopped（停业），closed（关闭）
样例 : "opened"

enum (opened, stopped, closed)

tags
可选

标签
样例 : [ "StoreTag" ]

< StoreTag > array

tax_no
可选

开票税号
样例 : "1245"

string

type
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

enum (self, self_join, managed_join, interal_join, single_store, other, direct, join)

2.7. StoreFilter

门店过滤器

名称 说明 类型

business_types
可选

业态
样例 : [ "string" ]

< string > array

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

id
可选

门店代码
样例 : "1323230"

string

key_like
可选

查询关键字类似于
样例 : "2134"

string

latitude_end
可选

纬度结束于
样例 : 89.0

number

latitude_start
可选

纬度起始于
样例 : 65.0

number

longtitude_end
可选

经度终止于
样例 : 120.0

number

longtitude_start
可选

经度起始于
样例 : 110.0

number

modified_end
可选

修改时间结束于
样例 : "2018-09-07 00:00:00"

string (date-time)

modified_start
可选

修改时间起始于
样例 : "2018-09-07 00:00:00"

string (date-time)

states
可选

门店状态：opened（正常），opened（停业），opened（关闭）
样例 : "opened"

< enum (opened, stopped, closed) > array

store_ids
可选

多个门店代码
样例 : [ "string" ]

< string > array

types
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

< enum (self, self_join, managed_join, interal_join, single_store, other, direct, join) > array

2.8. StoreList

门店列表对象

名称 说明 类型

stores
可选

门店列表
样例 : [ "Store" ]

< Store > array

2.9. StoreModification

门店修改对象

名称 说明 类型

account_name
可选

开票银行名称
样例 : "1245"

string

account_no
可选

开票银行账号
样例 : "1245"

string

area_leader
可选

区域主管
样例 : IdName

IdName

business_hours
可选

营业时间，形如 08:00-10:00;12:00-14:00 的字符串
样例 : "08:00-10:00;12:00-14:00"

string

business_type
可选

业态：ip（ip），park（乐园），early_education（早教）
样例 : "early_education"

string

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

contact
可选

联系方式
样例 : Contact

Contact

gid
可选

内部GID
样例 : "string"

string

location
可选

位置信息
样例 : Location

Location

name
必填

门店名称
样例 : "阳光店"

string

operation_manager
可选

运营经理
样例 : IdName

IdName

region
可选

样例 : StoreRegion

StoreRegion

remark
可选

备注
样例 : "第二个路口左转"

string

sap_code
可选

样例 : "string"

string

source_sys
可选

来源系统
样例 : "HDPOS4"

string

state
可选

门店状态：opened（正常），stopped（停业），closed（关闭）
样例 : "opened"

enum (opened, stopped, closed)

tags
可选

样例 : [ "StoreTag" ]

< StoreTag > array

tax_no
可选

开票税号
样例 : "1245"

string

type
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

enum (self, self_join, managed_join, interal_join, single_store, other, direct, join)

2.10. StorePaging

门店查询对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

stores
可选

门店列表
样例 : [ "Store" ]

< Store > array

total
可选

总记录数
样例 : 100

integer (int64)

2.11. StoreRegion

门店所属区域

名称 说明 类型

id
必填

区域代码
样例 : "2345456"

string

mgr_wechat_work_id
可选

区域经理企业微信id
样例 : "123456"

string

name
必填

区域名称
样例 : "阳光店"

string

2.12. StoreTag

名称 说明 类型

name
可选

样例 : "string"

string

2.13. Warehouse

仓库

名称 说明 类型

code
必填

代码
样例 : "00001"

string

contact
可选

仓库联系方式
样例 : WarehouseContact

WarehouseContact

gid
可选

仓库Gid
样例 : "gid"

string

location
可选

仓库位置信息
样例 : Location

Location

logistics_center_id
可选

物流中心代码
样例 : "00001"

string

logistics_center_name
可选

物流中心名称
样例 : "广州物流中行"

string

name
可选

名称
样例 : "广州仓"

string

2.14. WarehouseContact

名称 说明 类型

phone
可选

样例 : "string"

string

2.15. WarehouseList

仓库列表

名称 说明 类型

warehouses
必填

仓库列表
样例 : [ "Warehouse" ]

< Warehouse > array