# 地址业务相关

地址相关Api,使用交易网关接口,与微信/支付宝主小程序的逻辑一致。

# api域:

const addressServices = kreator.services.address;

# addressServices.getAddressList(param)

获取用户收货地址列表。
调用者需要明确业务场景来决定入参数量,如果不需要根据门店、商家筛选围栏内可用的收货地址,则可以将参数最简化,只需传入fence为false即可。
需过围栏筛选的情况需要非常谨慎地处理你的业务场景来决定入参的门店/商家Id,通常这样的场景仅出现在结算场景中,请务必确保筛选条件符合业务诉求。

参数名 类型 描述
param AddressListRequest 入参信息

# AddressListRequest类型:

参数名 类型 描述
fence boolean 地址是否通过围栏筛选
fenceConfig AddressFenceRequest[] 围栏筛选信息,fence为true时必传。
entryType string 配送模式,默认o2o
storeId string 门店ID,fence为true时必传。
venderId string 商家ID,fence为true时必传。

# AddressFenceRequest类型:

参数名 类型 描述
businessType string 门店业态
deliveryType string 门店配送模式,1配送到家/2自提
erpStoreId string 门店ID

# 返回值

any[] 收货地址信息列表

# addressServices.getAddressInfo(param)

根据地址ID获取地址详细信息。

参数名 类型 描述
param AddressInfoRequest 入参信息

# AddressInfoRequest类型:

参数名 类型 描述
id string 地址ID

# addressServices.getCityList()

获取省市区列表。
注意这里获取到的只是开通了多点服务的城市地区,没有多点相关服务的地区是不会返回的。

# 返回值

AddressCityInfo[] 城市相关信息

# AddressCityInfo类型:

参数名 类型 描述
areaId string 区号
areaLevel string 地区级别
areaList AddressCityInfo[] 市、县级地区
areaName string 地区名称

# addressServices.getPoiInfo(params: PoiInfoRequestInterface): Promise

根据经纬度查询地址详细信息。
后端通过高德地图Api查询地址信息。

# 入参

PoiInfoRequestInterface 经纬度信息

# PoiInfoRequestInterface类型:

参数名 类型 描述
longitude number 经度
latitude number 纬度