目录

创建门店

功能介绍

本接口用于商家向平台提交门店创建申请。商家通过传入门店信息,请求在平台侧注册新门店。平台接收到请求后,将进行数据校验并启动审核流程。

  • 所有后续操作(如更新、删除、查询)均需使用返回的venueId。
  • 商家侧门店编码(venueCode)请填写为门店跳转链接中对应的门店参数值,确保二者保持一致。

适用场景

接口原型

承载协议

HTTPS POST

接口方向

开发者服务器->华为服务器

接口URL

https://connect-api.cloud.huawei.com/api/ability-platform-connect/hag-developer/v1/venues

请求参数

[h2]Request Header

参数

是否必选

参数类型

描述

Content-Type

是

String

取值为:application/json;charset=UTF-8。

Authorization

是

String

通过接口访问凭证获取的鉴权令牌。

Bearer后面拼接空格,再拼接获取的鉴权信息。

client_id

否

String

服务商接入场景必传。

API客户端ID。

创建第三方平台成功后系统自动分配的客户端ID,可在第三方管理平台“开发管理资料 > 开发配置 > 开发资料设置”页面中获取,详情请参见接口访问凭证。

appId

是

String(64)

在创建应用后,由华为开发者联盟为应用分配的唯一标识。参数取值详见查看应用基本信息中的应用>APP ID。

x-traceid

否

String(100)

请求链路追踪ID,用于标识一次完整的调用链路,便于进行日志追踪和问题定位。

[h2]Request Body

参数

是否必选

参数类型

描述

venueName

是

String(100)

门店名称。

venueCode

否

String(64)

商家侧唯一门店编码。

可用于生成门店直达链接(后续支持根据该字段动态渲染跳转链接)。

categoryCode

是

String(32)

类目编码。参见元服务标签中标签ID。

latitude

是

Double

采用GCJ02坐标系,填写经度信息。

样例:31.97749。

longitude

是

Double

采用GCJ02坐标系,填写纬度信息。

样例:118.76421

detailedAddress

是

String(200)

详细地址。

样例:软件大道109号雨花客厅E-PARK购物中心9号楼1层12号。

remark

否

String(32)

门店备注。

brand

否

String(32)

品牌名。

contactPhone

否

String(20)

客服电话。

样例1:010-1234567

样例2:+86-13812345678

businessHours

否

List<BusinessHour>

营业时间。

详见数据结构BusinessHour。

mercNo

否

String(20)

关联商户号。

launchOptions

否

LaunchOptions

门店直达链接参数。元服务跳转链接参看LaunchOptions(元服务),应用跳转链接参看LaunchOptions(应用)。

images

是

List<ImageCreation>

图片列表,仅可传入一个图片。

province

否

String(50)

门店所在省份名称。

city

否

String(50)

门店所在城市名称。

district

否

String(50)

门店所在区名称。

BusinessHour

参数

是否必选

参数类型

描述

daysOfWeek

否

List<Integer>

每周营业时间。

例如:工作日取值[1,2,3,4,5],周末取值[6,7]。

timeSlots

否

List<TimeSlot>

营业时段。

样例:24小时营业时填入 {"start":"00:00","end":"23:59"}。

TimeSlot

参数

是否必选

参数类型

描述

start

否

String(10)

营业开始时间。

end

否

String(10)

营业结束时间。

LaunchOptions(元服务)

参数

是否必选

参数类型

描述

wantParam

必填

String(1024)

门店直达链接参数,实际打开元服务对应门店页面的参数。会通过

openAtomicService API跳转绑定的元服务。

链接格式为json字符串,内容为want.parameters参数。

例如:{"path":"page2", "venueId":123}。

LaunchOptions(应用)

参数

是否必选

参数类型

描述

appLinking

否

String(1024)

门店直达appLinking跳转链接

通过App Linking应用链接拉起指定应用

deepLink

否

String(1024)

门店直达deepLink跳转链接

minVersionCode

否

Integer

链接可支持的应用最小版本号

如果您配置的直达链接需要依赖已正式发布的应用版本,请提供对应应用的最小版本号。

版本号可在HarmonyOS 开发者中心中选择对应应用,进入软件包管理,查看依赖应用版本号。

ImageCreation-图片创建信息

参数

是否必选

参数类型

描述

imageMaterialId

条件必选

String(19)

通过图片上传接口获得的imageMaterialId。

mchFileUrl

条件必选

String(1024)

商家侧图片URL

与imageMaterialId二选一

typeId

条件必选

Integer

当填入商家侧图片URL时,该字段必选。

枚举定义参见:

图片规格说明

请求示例

POST https://connect-api.cloud.huawei.com/api/ability-platform-connect/hag-developer/v1/venues
Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
Content-Type: application/json;charset=UTF-8
appId: 5981*****5845

{
	"venueName": "venueName",
	"venueCode": "C001",
	"categoryCode": "30000203",
	"latitude": 34.101101,
	"longitude": 108.202202,
	"detailedAddress": "详细地址",
	"remark": "备注",
	"brand": "品牌方",
	"contactPhone": "010-1234567",
	"businessHours": [
		{
			"daysOfWeek": [
				1,
				2,
				3,
				4,
				5
			],
			"timeSlots": [
				{
					"start": "09:00",
					"end": "12:00"
				},
				{
					"start": "13:00",
					"end": "21:00"
				}
			]
		},
		{
			"daysOfWeek": [
				6,
				7
			],
			"timeSlots": [
				{
					"start": "08:00",
					"end": "12:00"
				},
				{
					"start": "13:00",
					"end": "22:00"
				}
			]
		}
	],
	"mercNo": "商户号",
	"launchOptions": {
		"wantParam": "{\"path\":\"page2\", \"venueId\":123}"
	}
}

响应参数

调用成功时,返回如下:

[h2]Response Header

参数

是否必选

参数类型

描述

Content-type

否

String

取值为:application/json;charset=UTF-8。

[h2]Response Body

参数

是否必选

参数类型

描述

errorCode

是

Integer

错误码。

errorDesc

是

String

错误描述信息。仅用于辅助定位问题和提示可读性错误原因,请勿用于业务逻辑判断或流程控制。

venueId

是

String(19)

创建生成的平台侧门店标识。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "errorCode": 0,
    "errorDesc": "Success",
    "venueId": "1773242566167455872"
}