Usage

1. Get Address List

API Method: getAddressList(options?: PageOptions): Promise<PageContent<AddressData>>

Parameter Description:

• options: PageOptions type, optional, default {}

Return Value Description: Promise<PageContent<AddressData>> type

Example:

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

2. Get Default Address

API Method: getDefaultAddress(): Promise<AddressData>

Return Value Description: Address information, Promise<AddressData> type, detailed type description as follows

Example:

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

3. Add Address

API Method: addAddress(params: AddressBasicData): Promise<AddressData>

Parameter Description:

• params: New address parameters, AddressBasicData type, required, detailed type description as follows

Return Value Description: Address information, Promise<AddressData> type, detailed type description as follows

Example:

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

4. Update Address

API Method: updateAddress(params: EditAddressParams): Promise<void>

Parameter Description:

• params: Update address parameters, EditAddressParams type, required, detailed type description as follows

Example:

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

5. Delete Address

API Method: deleteAddress(id: string): Promise<void>

Parameter Description:

• id: Address ID, string type, required

Example:

await addressTarget.deleteAddress('123');