useUser

The useUser hook returns the current user and functions for managing a Shopify customer account. The customer must have an active authentication session (see useAuth) for these methods to work.

The useUser hook returns an object with these properties:

The createUserAddress function adds a new address to the Shopify customer's address book.

Arguments:

createUserAddress(address, isDefaultAddress)

Returns:

Promise<void>: A Promise that resolves when the user address has been added.

Example:

The loadUser function reloads the current user. This is automatically called on every page load and with every other useUser method.

Arguments:

None.

Returns:

Promise<void>: A Promise that resolves when the user object has been added to Redux.

Example:

The modifyUserAddress function updates an address in the Shopify customer's address book.

Arguments:

modifyUserAddress(addressId, address, isDefaultAddress)

Returns:

Promise<void>: A Promise that resolves when the user address has been modified.

Example:

The modifyUserDefaultAddress function updates which address is marked as the default address in the Shopify customer's address book.

Arguments:

modifyUserDefaultAddress(addressId)

Returns:

Promise<void>: A Promise that resolves when the user address has been modified.

Example:

The removeUserAddress function removes an address from the Shopify customer's address book.

Arguments:

removeUserAddress(addressId)

Returns:

Promise<void>: A Promise that resolves when the user address has been removed.

Example: