保利威文档中心

幫助中心

使用方式

更新時間: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');
联系客服,在线咨询