Skip to main content

Class: AddressesResource

Hierarchy

  • default

    AddressesResource

Methods

addAddress

addAddress(payload, customHeaders?): ResponsePromise<StoreCustomersRes>

Adds an address to a customers saved addresses

Parameters

NameTypeDescription
payloadStorePostCustomersCustomerAddressesReqcontains information to create an address
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreCustomersRes>

Defined in

medusa-js/src/resources/addresses.ts:16


deleteAddress

deleteAddress(address_id, customHeaders?): ResponsePromise<StoreCustomersRes>

Deletes an address of a customer

Parameters

NameTypeDescription
address_idstringid of the address to delete
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreCustomersRes>

Defined in

medusa-js/src/resources/addresses.ts:30


updateAddress

updateAddress(address_id, payload, customHeaders?): ResponsePromise<StoreCustomersRes>

Update an address of a customer

Parameters

NameTypeDescription
address_idstringid of customer
payloadStorePostCustomersCustomerAddressesAddressReqaddress update
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreCustomersRes>

Defined in

medusa-js/src/resources/addresses.ts:45