---
title: "Loyalty programs and cards pipelines"
slug: "loyalty-programs-and-cards-pipelines"
abstract: ""
---
# Loyalty programs and cards pipelines

The integration and engagement logic used in the Loyalty Program and Card API is implemented by pipelines that can be customized as needed. There is a pipeline for each method on the API.

<details>
<summary><h2>GetLoyaltyProgram pipeline</h2></summary>

| **Name:** | GetLoyaltyProgram |
| --- | --- |
| **Description:** | Gets a specific loyalty program for a shop or user in a shop. |
| **Usage:** | Called via the `GetLoyaltyProgram` method on the Connect API when searching for loyalty programs. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: UserID, ShopName, and ProgramID. Is set prior to calling the pipeline. |
|  | **Response -**Contains the LoyaltyProgram object. Is read after the pipeline is executed. |
| **Processors:** | No default processors. |

</details>

<details>
<summary><h2>GetLoyaltyPrograms pipeline</h2></summary>

| **Name:** | GetLoyaltyPrograms |
| --- | --- |
| **Description:** | Gets a collection of loyalty programs for a shop or user in a shop. |
| **Usage:** | Called via the `GetLoyaltyPrograms` method on the Connect API when searching for loyalty programs. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: ShopName, UserId. Is set prior to calling the pipeline. |
|  | **Response -**Contains the collection of LoyaltyProgramSummary objects. Is read after the pipeline is executed. |
| **Processors:** | No default processors. |

</details>

<details>
<summary><h2>GetLoyaltyProgramStatus pipeline</h2></summary>

| **Name:** | GetLoyaltyProgramStatus |
| --- | --- |
| **Description:** | Gets the statuses for a loyalty card or specific programs that the card is associated to. |
| **Usage:** | Called via the `GetLoyaltyProgramStatus` method on the Connect API when searching for program statuses. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: LoyaltyCard object and a list of program IDs. Is set prior to calling the pipeline. |
|  | **Response**–A collection of LoyaltyProgramStatus objects. Is read after the pipeline is executed. |
| **Processors:** | No default processors. |

</details>

<details>
<summary><h2>JoinLoyaltyProgram pipeline</h2></summary>

| **Name:** | JoinLoyaltyProgram |
| --- | --- |
| **Description:** | Joins a user to all or a specific program in a store. |
| **Usage:** | Called via the `JoinLoyaltyProgram` method on the Connect API when trying to join a user to a program(s).. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: userId, shopName, and programId. Is set prior to calling the pipeline. |
|  | **Response****–**A LoyaltyCard object. Is read after the pipeline is executed. |
| **Processors:** |  |
|  | **TriggerLoyaltyProgramJoinedGoal****–**Triggers the Loyalty Program Joined goal<br><br>**AddVisitorToEaPlan** – Adds the user to an EAP for joining a loyalty program. |

</details>

<details>
<summary><h2>GetLoyaltyCards pipeline</h2></summary>

| **Name:** | GetLoyaltyCards |
| --- | --- |
| **Description:** | Gets the loyalty cards for the user in a store or a specific card. |
| **Usage:** | Called via the `GetLoyaltyCards` method on the Connect API when trying to retrieve a card. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: UserID, ShopName, and CardId. Is set prior to calling the pipeline. |
|  | **Response -**Contains the collection of LoyaltyCard objects. Is read after the pipeline is executed. |
| **Processors:** | No default processors. |

</details>

<details>
<summary><h2>GetLoyaltyCardTransactions pipeline</h2></summary>

| **Name:** | GetLoyaltyCardTransactions |
| --- | --- |
| **Description:** | Gets all of the transactions for a specific card. |
| **Usage:** | Called via the `GetLoyaltyCardTransactions` method on the Connect API when retrieving for statuses. |
| **Args:** |  |
|  | **Request -**Contains the search criteria: LoyaltyCard. Is set prior to calling the pipeline. |
|  | **Response -**Contains the collection of LoyaltyCardTransaction objects. Is read after the pipeline is executed. |
| **Processors:** | No default processors. |

</details>