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.
CreateWishList pipeline
Name: |
CreateWishList |
Description: |
The pipeline is responsible for creating a wish list and raising an associated page event. |
Usage: |
Called via the |
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 – Responsibility – Raises the WishList Created page event. |
DeleteWishList pipeline
Name: |
DeleteWishList |
Description: |
The pipeline is responsible for deleting a wish list and raising an associated page event. |
Usage: |
Called via the |
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 – Responsibility – Raises the WishLists Deleted page event. |
EmailWishLists pipeline
Name: |
EmailWishLists |
Description: |
Sends an email message with a specified wish list and raises an associated page event. |
Usage: |
Called via the |
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 – Responsibility – Raises the WishList Emailed page event. |
GetWishList pipeline
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 |
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 |
GetWishLists pipeline
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 |
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 |
UpdateWishList pipeline
Name: |
UpdateWishList |
Description: |
The pipeline is responsible for updating select line items on a wish list. |
Usage: |
Called via the |
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 |
RemoveWishListLines pipeline
Name: |
RemoveWishListLines |
Description: |
The pipeline is responsible for removing selected line items from a wish list. |
Usage: |
Called using the |
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 – Responsibility – Raises the Lines Removed From WishList page event. |
UpdateWishListLines pipeline
Name: |
UpdateWishListLines |
Description: |
The pipeline is responsible for updating specific line items already added to the wish list. |
Usage: |
Called via the |
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 – Responsibility – Raises the Lines Updated On WishList page event. |
AddLinesToWishList pipeline
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 |
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 – Responsibility– Raises the Lines Added To WishList page event. |
PrintWishList pipeline
Name: |
PrintWishList |
Description: |
The pipeline is responsible for retrieving a wish list object for printing. |
Usage: |
Called using the |
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 – Responsibility – Raises the Lines Removed From WishList page event. |