createCustomerAddresses - Customer Module Reference

This documentation provides a reference to the createCustomerAddresses method. This belongs to the Customer Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

createCustomerAddresses(addresses, sharedContext?): Promise<CustomerAddressDTO[]>#

This method adds addresses to customers.

Example#

Code
1const addresses = await customerModuleService.createCustomerAddresses([2  {3    customer_id: "cus_123",4    address_name: "Home",5    address_1: "432 Stierlin Rd",6    city: "Mountain View",7    country_code: "us",8  },9])

Parameters#

addressesCreateCustomerAddressDTO[]

A list of items, each being the details of the address to add to a customer.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<CustomerAddressDTO[]>

The list of created addresses.

createCustomerAddresses(address, sharedContext?): Promise<CustomerAddressDTO>#

This method adds an address to a customer.

Example#

Code
1const address = await customerModuleService.createCustomerAddresses({2  customer_id: "cus_123",3  address_name: "Home",4  address_1: "432 Stierlin Rd",5  city: "Mountain View",6  country_code: "us",7})

Parameters#

addressCreateCustomerAddressDTO

The details of the address to add to a customer.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<CustomerAddressDTO>

The created address.