文档中心 > API类目 > 本地生活商户基础API

alibaba.alsc.koubei.store.sync (三方供给店铺同步服务)

三方供给店铺同步服务

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_third_store_sync_data_request ThirdStoreSyncDataRequest 必须 三方店铺同步请求
  • └ address
  • String
  • 必须
  • 万塘路18号黄龙时代广场
  • 万塘路18号黄龙时代广场
  • └ branch_store_name
  • String
  • 可选
  • 分店名称 弃用
  • 弃用,使用main_store_name传值
  • └ category_id
  • String
  • 可选
  • 2015050700000010
  • 线下提供的本地生活店铺的类目列表
  • └ city_name
  • String
  • 可选
  • 杭州市
  • 城市名称。高德poiId和省份、城市、区县 二选一。 当高德poiId为空时,省份、城市、区县不能为空。 当省份、城市、区县为空,高德poiId不能为空
  • └ district_name
  • String
  • 可选
  • 西湖区
  • 区县名称。高德poiId和省份、城市、区县 二选一。 当高德poiId为空时,省份、城市、区县不能为空。 当省份、城市、区县为空,高德poiId不能为空
  • └ gaode_poi
  • String
  • 可选
  • EI234234
  • 高德poiId
  • └ latitude
  • String
  • 必须
  • 30.548828
  • 纬度;最长15位字符(包括小数点), 注:高德坐标系。经纬度是门店搜索和活动推荐的重要参数,录入时请确保经纬度参数准确。高德经纬度查询:http://lbs.amap.com/console/show/picker
  • └ licence
  • String
  • 必须
  • i3/2200781230370/xxxxkoubei.png
  • 门店资质及营业执照图片信息,调用素材接口返回的图片short_url,最少1个地址,最多5个,多个以英文逗号分隔
  • └ longitude
  • String
  • 必须
  • 114.266418
  • 经度;最长15位字符(包括小数点), 注:高德坐标系。经纬度是门店搜索和活动推荐的重要参数,录入时请确保经纬度参数准确。高德经纬度查询:http://lbs.amap.com/console/show/picker
  • └ main_store_name
  • String
  • 必须
  • 肯德基
  • 比如:肯德基;肯德基(人民广场店)。店名里可以包含分店名,分店名用英文括号包括。店名长度不能超过20个字符。
  • └ province_name
  • String
  • 可选
  • 浙江省
  • 省份名称。高德poiId和省份、城市、区县 二选一。 当高德poiId为空时,省份、城市、区县不能为空。 当省份、城市、区县为空,高德poiId不能为空
  • └ request_id
  • String
  • 必须
  • wkejrlw234234234
  • 请求id。表示唯一性,用于幂等控制
  • └ seller_id
  • String
  • 必须
  • 789234
  • 三方服务商在本地生活注册的sellerId
  • └ third_store_id
  • String
  • 必须
  • 34243
  • 外部门店编号;最长32位字符,该编号将作为收单接口的入参, 请开发者自行确保其唯一性。
  • └ is_history_tag
  • Boolean
  • 必须
  • false
  • 是否历史数据,历史数据量大,无法在短时间内处理完,需要算法做特殊处理
  • └ test_store
  • Boolean
  • 可选
  • false
  • 是否测试店铺
  • └ cover
  • String
  • 可选
  • i3/2200781230370/xxxxkoubei.png
  • 店铺门头图,调用素材接口返回的图片short_url
  • └ concat_info
  • String
  • 可选
  • 0571-88866686
  • 可填手机号或座机号。手机号可以选填国家区号,手机号格式 13344445555。 座机号格式 0561-11112222
  • └ alsc_store_id
  • String
  • 可选
  • 1056040032
  • 匹配的口碑侧门店id。 传参此参数视为修改cover和concatInfo操作,此操作为实时修改,无奇门接口通知,修改数据为门店侧数据,如有其他侧离线同步使用此数据,请等待离线同步后查看最新修改数据。 必填参数均需填写,cover和concatInfo可单独填写,如填写视为修改。 其他参数不参与修改与验证,只验证cover和concatInfo
  • └ sync_type
  • String
  • 可选
  • sync
  • 三方同步类型, sync:同步匹配; modify:修改,目前支持修改联系方式和门头图(需传有权限的alsc_store_id,传参见alsc_store_id)

响应参数

名称 类型 示例值 描述
result Result 三方店铺同步结果
  • └ error_code
  • String
  • invalid_params
  • 错误码
  • └ error_msg
  • String
  • 参数错误
  • 错误信息
  • └ success
  • String
  • true/false
  • 是否成功
  • model
  • ThirdStoreRelationVO
  • 店铺关系模型
  • └ third_store_id
  • String
  • 234234
  • 三方服务商店铺id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscKoubeiStoreSyncRequest req = new AlibabaAlscKoubeiStoreSyncRequest();
AlibabaAlscKoubeiStoreSyncRequest.ThirdStoreSyncDataRequest obj1 = new AlibabaAlscKoubeiStoreSyncRequest.ThirdStoreSyncDataRequest();
obj1.setAddress("万塘路18号黄龙时代广场");
obj1.setBranchStoreName("分店名称 弃用");
obj1.setCategoryId("2015050700000010");
obj1.setCityName("杭州市");
obj1.setDistrictName("西湖区");
obj1.setGaodePoi("EI234234");
obj1.setLatitude("30.548828");
obj1.setLicence("i3/2200781230370/xxxxkoubei.png");
obj1.setLongitude("114.266418");
obj1.setMainStoreName("肯德基");
obj1.setProvinceName("浙江省");
obj1.setRequestId("wkejrlw234234234");
obj1.setSellerId("789234");
obj1.setThirdStoreId("34243");
obj1.setIsHistoryTag(false);
obj1.setTestStore(false);
obj1.setCover("i3/2200781230370/xxxxkoubei.png");
obj1.setConcatInfo("0571-88866686");
obj1.setAlscStoreId("1056040032");
obj1.setSyncType("sync");
req.setParamThirdStoreSyncDataRequest(obj1);
AlibabaAlscKoubeiStoreSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_alsc_koubei_store_sync_response>
    <result>
        <error_code>invalid_params</error_code>
        <error_msg>参数错误</error_msg>
        <success>true/false</success>
        <model>
            <third_store_id>234234</third_store_id>
        </model>
    </result>
</alibaba_alsc_koubei_store_sync_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部