---
title: "Wish lists pipelines"
slug: "wish-lists-pipelines"
abstract: ""
---
# Wish lists pipelines

The integration and engagement logic used in the Cart API is implemented by pipelines that can be customized as needed. There is a pipeline for each method on the API. Some pipelines call other common pipelines such as `SaveCart` and `LoadCart`. In some cases the logic is split into several sub-pipelines to handle if-then-else situations, such as those used in the `CreateOrResumeCart` pipeline.

<details>
<summary><h2>CreateWishList pipeline</h2></summary>

| **Name:** | CreateWishList |
| --- | --- |
| **Description:** | The pipeline is responsible for creating a wish list and raising an associated page event. |
| **Usage:** | Called via the `CreateWishList` method on the Connect API when creating wish lists. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: UserID, WishListName and ShopName. Is set prior to calling the pipeline. |
|  | **Response -**Contains the created wish list object. Is read after the pipeline is executed. |
| **Processors:** | **TriggerWishListCreatedPageEvent** **–**<br><br>**Responsibility** – Raises the WishList Created page event. |

</details>

<details>
<summary><h2>DeleteWishList pipeline</h2></summary>

| **Name:** | DeleteWishList |
| --- | --- |
| **Description:** | The pipeline is responsible for deleting a wish list and raising an associated page event. |
| **Usage:** | Called via the `DeleteWishList` method on the Connect API when deleting a wish list. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: WishList. Is set prior to calling the pipeline. |
|  | **Response -**Contains the WishList object. Is read after the pipeline is executed. |
| **Processors:** | **TriggerWishListDeletedPageEvent** **–**<br><br>**Responsibility** – Raises the WishLists Deleted page event. |

</details>

<details>
<summary><h2>EmailWishLists pipeline</h2></summary>

| **Name:** | EmailWishLists |
| --- | --- |
| **Description:** | Sends an email message with a specified wish list and raises an associated page event. |
| **Usage:** | Called via the `EmailWishLists` method on the Connect API when sending an email message with wish lists. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: IEnumerable<WishList>. Is set prior to calling the pipeline. |
|  | **Response -**Contains an IEnumerable<WishList>. Is read after the pipeline is executed. |
| **Processors:** | **TriggerWishListsEmailedPageEvent** **–**<br><br>**Responsibility** – Raises the WishList Emailed page event. |

</details>

<details>
<summary><h2>GetWishList pipeline</h2></summary>

| **Name:** | GetWishList |
| --- | --- |
| **Description:** | The pipeline is responsible for performing a search against all wish lists and returning a WishList instance that matches the specified search criteria. |
| **Usage:** | Called via the `GetWishLists` method on the Connect API when searching for a wish list. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: UserId, WishlistId, and ShopName. Is set prior to calling the pipeline. |
|  | **Response -**Contains the matching WishList object. Is read after the pipeline is executed. |
| **Processors:** | No default processors |

</details>

<details>
<summary><h2>GetWishLists pipeline</h2></summary>

| **Name:** | GetWishLists |
| --- | --- |
| **Description:** | The pipeline is responsible for performing a search against all wish lists and returning a list of WishListHeader instances for carts found, matching the specified search criteria. |
| **Usage:** | Called via the `GetWishLists` method on the Connect API when searching for wish lists. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: UserID and ShopName. Is set prior to calling the pipeline. |
|  | **Response -**Contains the WishListHeader objects. Is read after the pipeline is executed. |
| **Processors:** | No default processors |

</details>

<details>
<summary><h2>UpdateWishList pipeline</h2></summary>

| **Name:** | UpdateWishList |
| --- | --- |
| **Description:** | The pipeline is responsible for updating select line items on a wish list. |
| **Usage:** | Called via the `UpdateWishList` method on the Connect API when updating a wish list. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: WishList. Is set prior to calling the pipeline. |
|  | **Response -**Contains the WishList object. Is read after the pipeline is executed. |
| **Processors:** | No default processors |

</details>

<details>
<summary><h2>RemoveWishListLines pipeline</h2></summary>

| **Name:** | RemoveWishListLines |
| --- | --- |
| **Description:** | The pipeline is responsible for removing selected line items from a wish list. |
| **Usage:** | Called using the `RemoveWishListLines` method on the Connect API when searching for carts. |
| **Args:** |  |
|  | **Request -**Contains the search criteria WishList, and a list of line item IDs to remove. Is set prior to calling the pipeline. |
|  | **Response -**Contains the updated wish list and the line items object that were removed. Is read after the pipeline is executed. |
| **Processors:** | **TriggerLinesRemovedFromWishListPageEvent** **–**<br><br>**Responsibility** – Raises the Lines Removed From WishList page event. |

</details>

<details>
<summary><h2>UpdateWishListLines pipeline</h2></summary>

| **Name:** | UpdateWishListLines |
| --- | --- |
| **Description:** | The pipeline is responsible for updating specific line items already added to the wish list. |
| **Usage:** | Called via the `UpdateWishListLines` method on the Connect API when updating line items on a wish list. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: WishList and a collection of WishListItems. Is set prior to calling the pipeline. |
|  | **Response -**Contains the updated wish list and the requested wish list items to update. Is read after the pipeline is executed. |
| **Processors:** | **TriggerLinesUpdatedOnWishListPageEvent****–**<br><br>**Responsibility** – Raises the Lines Updated On WishList page event. |

</details>

<details>
<summary><h2>AddLinesToWishList pipeline</h2></summary>

| **Name:** | AddLinesToWishList |
| --- | --- |
| **Description:** | The pipeline is responsible for adding new line items to a cart and raising an associated page event. |
| **Usage:** | Called via the `AddLinesToWishList` method on the Connect API when adding new lines to a wish list. |
| **Args:** |  |
|  | **Request -**Contains the criteria: WishList and a collection of WishListItems. Is set prior to calling the pipeline. |
|  | **Response -**Contains the updated WishList and the initial WishListItem objects. Is read after the pipeline is executed. |
| **Processors:** | **TriggerLinesAddedToWishListPageEvent** **–**<br><br>**Responsibility**– Raises the Lines Added To WishList page event. |

</details>

<details>
<summary><h2>PrintWishList pipeline</h2></summary>

| **Name:** | PrintWishList |
| --- | --- |
| **Description:** | The pipeline is responsible for retrieving a wish list object for printing. |
| **Usage:** | Called using the `PrintWishList` method on the Connect API when searching for a wish list to print. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: WishList object. Is set prior to calling the pipeline. |
|  | **Response -**Contains the WishList object to print. Is read after the pipeline is executed. |
| **Processors:** | **TriggerWishListPrintedPageEvent****–**<br><br>**Responsibility** – Raises the Lines Removed From WishList page event. |

</details>