保利威文档中心

帮助中心

使用方式

更新时间:2025-09-05 09:41:51

一、获取地址列表

Api 方法: getAddressList(options?: PageOptions): Promise<PageContent<AddressData>>

参数说明:

  • options:PageOptions 类型,选传,默认 {}

返回值说明: Promise<PageContent<AddressData>> 类型

示例:

const data = await addressTarget.getAddressList({ pageNumber: 1, pageSize: 10 });
console.log('地址列表', data.contents);

二、获取默认地址

Api 方法: getDefaultAddress(): Promise<AddressData>

返回值说明: 地址信息,Promise<AddressData> 类型,详细类型说明如下

属性名 说明 类型
address 地址 string
area 所在地区 string
mobile 手机号 string
name 收货人姓名 string
id 地址id string

示例:

const data = await addressTarget.getDefaultAddress();
console.log('默认地址', data);

三、新增地址

Api 方法: addAddress(params: AddressBasicData): Promise<AddressData>

参数说明:

  • params:新增地址参数,AddressBasicData 类型,必传,详细类型说明如下
参数名 说明 类型 必须 默认值
address 地址 string -
area 所在地区 string -
mobile 手机号 string -
name 收货人姓名 string -

返回值说明: 地址信息,Promise<AddressData> 类型,详细类型说明如下

属性名 说明 类型
address 地址 string
area 所在地区 string
mobile 手机号 string
name 收货人姓名 string
id 地址id string

示例:

const data = await addressTarget.addAddress({
  phone: '13800138000',
  name: '张三',
  area: '广东省/广州市/番禺区',
  address: '国家创新创业基地',
});
console.log('新增地址', data);

四、修改地址

Api 方法: updateAddress(params: EditAddressParams): Promise<void>

参数说明:

  • params:修改地址参数,EditAddressParams 类型,必传,详细类型说明如下
参数名 说明 类型 必须 默认值
address 地址 string -
area 所在地区 string -
mobile 手机号 string -
name 收货人姓名 string -
id 地址id string -

示例:

await addressTarget.updateAddress({
  id: '123',
  address: '国家创新创业基地',
  area: '广东省/广州市/番禺区',
  phone: '13800138000',
  name: '张三',
});

五、删除地址

Api 方法: deleteAddress(id: string): Promise<void>

参数说明:

  • id:地址 id,string 类型,必传

示例:

await addressTarget.deleteAddress('123');
联系客服,在线咨询