Class: AddressesResource
Hierarchy
defaultCopy to Clipboard↳
AddressesResourceCopy to Clipboard
Methods
addAddress
▸ addAddress(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Adds an address to a customers saved addresses
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersCustomerAddressesReqCopy to Clipboard | contains information to create an address |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/addresses.ts:16
deleteAddress
▸ deleteAddress(address_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Deletes an address of a customer
Parameters
| Name | Type | Description |
|---|---|---|
address_idCopy to Clipboard | stringCopy to Clipboard | id of the address to delete |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/addresses.ts:30
updateAddress
▸ updateAddress(address_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Update an address of a customer
Parameters
| Name | Type | Description |
|---|---|---|
address_idCopy to Clipboard | stringCopy to Clipboard | id of customer |
payloadCopy to Clipboard | StorePostCustomersCustomerAddressesAddressReqCopy to Clipboard | address update |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>