3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
2.6 KiB
2.6 KiB
Class: AddressesResource
Hierarchy
-
default↳
AddressesResource
Methods
addAddress
▸ addAddress(payload, customHeaders?): ResponsePromise<StoreCustomersRes>
Adds an address to a customers saved addresses
Parameters
| Name | Type | Description |
|---|---|---|
payload |
StorePostCustomersCustomerAddressesReq |
contains information to create an address |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreCustomersRes>
Defined in
packages/medusa-js/src/resources/addresses.ts:16
deleteAddress
▸ deleteAddress(address_id, customHeaders?): ResponsePromise<StoreCustomersRes>
Deletes an address of a customer
Parameters
| Name | Type | Description |
|---|---|---|
address_id |
string |
id of the address to delete |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreCustomersRes>
Defined in
packages/medusa-js/src/resources/addresses.ts:29
updateAddress
▸ updateAddress(address_id, payload, customHeaders?): ResponsePromise<StoreCustomersRes>
Update an address of a customer
Parameters
| Name | Type | Description |
|---|---|---|
address_id |
string |
id of customer |
payload |
StorePostCustomersCustomerAddressesAddressReq |
address update |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreCustomersRes>