AddressesResource

addresses.AddressesResource

Methods

addAddress

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

Adds an address to a customers saved addresses

Parameters

payloadStorePostCustomersCustomerAddressesReqRequired

contains information to create an address

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required

---

deleteAddress

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

Deletes an address of a customer

Parameters

address_idstringRequired

id of the address to delete

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required

---

updateAddress

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

Update an address of a customer

Parameters

address_idstringRequired

id of customer

payloadStorePostCustomersCustomerAddressesAddressReqRequired

address update

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required