-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added an upgrade guide for 1.7.0 (#2750)
- Loading branch information
1 parent
29135c0
commit beecd49
Showing
2 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
description: 'Actions Required for v.1.7.0' | ||
--- | ||
|
||
# v1.7.0 | ||
|
||
Version `1.7.0` of Medusa introduces a breaking change in the [CustomerService](../../../references/services/classes/CustomerService.md). | ||
|
||
## Overview | ||
|
||
In this new version, the method [`retrieveByEmail` in the Customer Service](../../../references/services/classes/CustomerService.md#retrievebyemail) has been deprecated in favor of other methods. Read the actions required below to learn which methods to use instead. | ||
|
||
## Actions Required | ||
|
||
Instead of using `customerService.retrieveByEmail`, you should now use the methods `customerService.retrieveRegisteredByEmail` or `customerService.retrieveUnRegisteredByEmail`. | ||
|
||
The `customerService.retrieveRegisteredByEmail` method allows you to retrieve a registered customer by email: | ||
|
||
```tsx | ||
customerService.retrieveRegisteredByEmail("[email protected]"); | ||
``` | ||
|
||
On the other hand, the `retrieveUnregisteredByEmail` method allows to retrieve guest customers by email: | ||
|
||
```jsx | ||
customerService.retrieveUnRegisteredByEmail("[email protected]"); | ||
``` | ||
|
||
To retrieve a customer by email regardless of whether they are registered or not, you can use the `customerService.list` method instead: | ||
|
||
```tsx | ||
customerService.list({ | ||
email: "[email protected]" | ||
}) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters