GET loyaltyPrograms?id={id}

Gets a Loyalty Program by it's ID, represented as LoyaltyProgramDto.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the LoyaltyProgram.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

The LoyaltyProgramDto data.

LoyaltyProgramDto

Name	Type	Additional information
Id	globally unique identifier	None.
IdNetwork	globally unique identifier	None.
Code	string	None.
Description	string	None.
ConciliationEmailFromName	string	None.
ConciliationEmailFromAddress	string	None.
TargetMembers	integer	None.
InternalCode	string	None.
StartDate	date	None.
Periodicity	byte	None.
Duration	integer	None.
LastRenovationDate	date	None.
SupportsDualIdentification	boolean	None.
ExpirationType	byte	None.
ProgramType	byte	None.
ExpirationPeriodicity	byte	None.
ExpirationDuration	integer	None.
Active	boolean	None.
InitialSurvey	boolean	None.
IdLoyaltyUnits	globally unique identifier	None.
IdServiceEntryTypesGroup	globally unique identifier	None.
GraceDays	byte	None.
IdCompany	globally unique identifier	None.
IdSite	globally unique identifier	None.
InitialAmount	decimal number	None.
ExternalHostProcess	boolean	None.
NotificationPointAlert	decimal number	None.
RedemptionDiscount	decimal number	None.
SupportPhoneNumber	string	None.
LoyaltyProgramRatio	Collection of LoyaltyProgramRatioDto	None.
LoyaltyProgramsZones	Collection of globally unique identifier	None.
LoyaltyProgramsSites	Collection of globally unique identifier	None.
LoyaltyProgramBinRanges	Collection of LoyaltyProgramBinRangeDto	None.
LoyaltyProgramEliteStatuses	Collection of LoyaltyProgramEliteStatusDto	None.
SupportsStockManagement	boolean	None.
AllowMultipleIdentities	boolean	None.
EmailNotifications	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "407dfd47-8b10-44f5-8af9-f4a795077722",
  "IdNetwork": "2a359071-7597-4fb4-a1d3-f70640857d53",
  "Code": "sample string 3",
  "Description": "sample string 4",
  "ConciliationEmailFromName": "sample string 5",
  "ConciliationEmailFromAddress": "sample string 6",
  "TargetMembers": 7,
  "InternalCode": "sample string 8",
  "StartDate": "2025-04-25T16:40:24.2871219Z",
  "Periodicity": 64,
  "Duration": 11,
  "LastRenovationDate": "2025-04-25T16:40:24.2871219Z",
  "SupportsDualIdentification": true,
  "ExpirationType": 64,
  "ProgramType": 64,
  "ExpirationPeriodicity": 64,
  "ExpirationDuration": 1,
  "Active": true,
  "InitialSurvey": true,
  "IdLoyaltyUnits": "66de09e0-90fa-4a2d-b82e-4fbe3c0b08fd",
  "IdServiceEntryTypesGroup": "29ec3430-9aae-474a-8c9d-45a416bb8efa",
  "GraceDays": 64,
  "IdCompany": "a7f24ad4-d96c-48f6-acd5-74eda0aa2d68",
  "IdSite": "eb7bb65b-5976-4648-9073-64ecfc73ab02",
  "InitialAmount": 1.0,
  "ExternalHostProcess": true,
  "NotificationPointAlert": 1.0,
  "RedemptionDiscount": 1.0,
  "SupportPhoneNumber": "sample string 19",
  "LoyaltyProgramRatio": [
    {
      "Id": "97a271ee-261a-4171-9b50-c75610bb825d",
      "IdLoyaltyProgram": "85fa85bf-057a-45d8-8079-d4f4d4eab6e1",
      "IdStockKeepingUnit": "9e0bcb0a-d2e0-466b-9bfa-ca5ec0e01e6c",
      "Type": 4,
      "Name": "sample string 5",
      "loyaltyProgramRatioValidities": [
        {
          "Id": "450ed7bd-14ec-4f64-b7a9-98c4ec5430cc",
          "IdLoyaltyProgramRatio": "2401308b-879b-4557-962b-542f74a25eb2",
          "DateFrom": "2025-04-25T16:40:24.2871219Z",
          "DateTo": "2025-04-25T16:40:24.2871219Z",
          "AmountRatio": 4.0,
          "PointsRatio": 5.0,
          "DiscountRatio": 6.0
        },
        {
          "Id": "450ed7bd-14ec-4f64-b7a9-98c4ec5430cc",
          "IdLoyaltyProgramRatio": "2401308b-879b-4557-962b-542f74a25eb2",
          "DateFrom": "2025-04-25T16:40:24.2871219Z",
          "DateTo": "2025-04-25T16:40:24.2871219Z",
          "AmountRatio": 4.0,
          "PointsRatio": 5.0,
          "DiscountRatio": 6.0
        }
      ]
    },
    {
      "Id": "97a271ee-261a-4171-9b50-c75610bb825d",
      "IdLoyaltyProgram": "85fa85bf-057a-45d8-8079-d4f4d4eab6e1",
      "IdStockKeepingUnit": "9e0bcb0a-d2e0-466b-9bfa-ca5ec0e01e6c",
      "Type": 4,
      "Name": "sample string 5",
      "loyaltyProgramRatioValidities": [
        {
          "Id": "450ed7bd-14ec-4f64-b7a9-98c4ec5430cc",
          "IdLoyaltyProgramRatio": "2401308b-879b-4557-962b-542f74a25eb2",
          "DateFrom": "2025-04-25T16:40:24.2871219Z",
          "DateTo": "2025-04-25T16:40:24.2871219Z",
          "AmountRatio": 4.0,
          "PointsRatio": 5.0,
          "DiscountRatio": 6.0
        },
        {
          "Id": "450ed7bd-14ec-4f64-b7a9-98c4ec5430cc",
          "IdLoyaltyProgramRatio": "2401308b-879b-4557-962b-542f74a25eb2",
          "DateFrom": "2025-04-25T16:40:24.2871219Z",
          "DateTo": "2025-04-25T16:40:24.2871219Z",
          "AmountRatio": 4.0,
          "PointsRatio": 5.0,
          "DiscountRatio": 6.0
        }
      ]
    }
  ],
  "LoyaltyProgramsZones": [
    "0bdf3227-170a-47fc-b718-cdeccde2e053",
    "a6c9123e-8136-40da-8bd1-02d063c4d58b"
  ],
  "LoyaltyProgramsSites": [
    "065815f6-7a6e-4b8c-aa92-d8b17c786718",
    "c8853a50-b447-4e7e-b0d9-25e27f0a0ff8"
  ],
  "LoyaltyProgramBinRanges": [
    {
      "Id": "a3de3e5b-ed71-4da6-afee-4a8266ef1c45",
      "IdLoyaltyProgram": "119e7b04-5c31-4860-b432-7f9f722ea05a",
      "BinRange": "sample string 3",
      "LoyaltyProgramCode": "sample string 4"
    },
    {
      "Id": "a3de3e5b-ed71-4da6-afee-4a8266ef1c45",
      "IdLoyaltyProgram": "119e7b04-5c31-4860-b432-7f9f722ea05a",
      "BinRange": "sample string 3",
      "LoyaltyProgramCode": "sample string 4"
    }
  ],
  "LoyaltyProgramEliteStatuses": [
    {
      "Id": "beb9cfb2-d7e6-4a52-88b5-ff375725ca5b",
      "IdLoyaltyProgram": "d5659903-42d9-4961-b1da-fa611e8e783d",
      "Code": "sample string 3",
      "Name": "sample string 4",
      "Type": 64,
      "DateFrom": "2025-04-25T16:40:24.5215003Z",
      "DateTo": "2025-04-25T16:40:24.5215003Z",
      "Active": true
    },
    {
      "Id": "beb9cfb2-d7e6-4a52-88b5-ff375725ca5b",
      "IdLoyaltyProgram": "d5659903-42d9-4961-b1da-fa611e8e783d",
      "Code": "sample string 3",
      "Name": "sample string 4",
      "Type": 64,
      "DateFrom": "2025-04-25T16:40:24.5215003Z",
      "DateTo": "2025-04-25T16:40:24.5215003Z",
      "Active": true
    }
  ],
  "SupportsStockManagement": true,
  "AllowMultipleIdentities": true,
  "EmailNotifications": true
}

application/xml, text/xml

Sample:

<LoyaltyProgramDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
  <_x003C_Active_x003E_k__BackingField>true</_x003C_Active_x003E_k__BackingField>
  <_x003C_AllowMultipleIdentities_x003E_k__BackingField>true</_x003C_AllowMultipleIdentities_x003E_k__BackingField>
  <_x003C_Code_x003E_k__BackingField>sample string 3</_x003C_Code_x003E_k__BackingField>
  <_x003C_ConciliationEmailFromAddress_x003E_k__BackingField>sample string 6</_x003C_ConciliationEmailFromAddress_x003E_k__BackingField>
  <_x003C_ConciliationEmailFromName_x003E_k__BackingField>sample string 5</_x003C_ConciliationEmailFromName_x003E_k__BackingField>
  <_x003C_Description_x003E_k__BackingField>sample string 4</_x003C_Description_x003E_k__BackingField>
  <_x003C_Duration_x003E_k__BackingField>11</_x003C_Duration_x003E_k__BackingField>
  <_x003C_EmailNotifications_x003E_k__BackingField>true</_x003C_EmailNotifications_x003E_k__BackingField>
  <_x003C_ExpirationDuration_x003E_k__BackingField>1</_x003C_ExpirationDuration_x003E_k__BackingField>
  <_x003C_ExpirationPeriodicity_x003E_k__BackingField>64</_x003C_ExpirationPeriodicity_x003E_k__BackingField>
  <_x003C_ExpirationType_x003E_k__BackingField>64</_x003C_ExpirationType_x003E_k__BackingField>
  <_x003C_ExternalHostProcess_x003E_k__BackingField>true</_x003C_ExternalHostProcess_x003E_k__BackingField>
  <_x003C_GraceDays_x003E_k__BackingField>64</_x003C_GraceDays_x003E_k__BackingField>
  <_x003C_IdCompany_x003E_k__BackingField>a7f24ad4-d96c-48f6-acd5-74eda0aa2d68</_x003C_IdCompany_x003E_k__BackingField>
  <_x003C_IdLoyaltyUnits_x003E_k__BackingField>66de09e0-90fa-4a2d-b82e-4fbe3c0b08fd</_x003C_IdLoyaltyUnits_x003E_k__BackingField>
  <_x003C_IdNetwork_x003E_k__BackingField>2a359071-7597-4fb4-a1d3-f70640857d53</_x003C_IdNetwork_x003E_k__BackingField>
  <_x003C_IdServiceEntryTypesGroup_x003E_k__BackingField>29ec3430-9aae-474a-8c9d-45a416bb8efa</_x003C_IdServiceEntryTypesGroup_x003E_k__BackingField>
  <_x003C_IdSite_x003E_k__BackingField>eb7bb65b-5976-4648-9073-64ecfc73ab02</_x003C_IdSite_x003E_k__BackingField>
  <_x003C_Id_x003E_k__BackingField>407dfd47-8b10-44f5-8af9-f4a795077722</_x003C_Id_x003E_k__BackingField>
  <_x003C_InitialAmount_x003E_k__BackingField>1</_x003C_InitialAmount_x003E_k__BackingField>
  <_x003C_InitialSurvey_x003E_k__BackingField>true</_x003C_InitialSurvey_x003E_k__BackingField>
  <_x003C_InternalCode_x003E_k__BackingField>sample string 8</_x003C_InternalCode_x003E_k__BackingField>
  <_x003C_LastRenovationDate_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_LastRenovationDate_x003E_k__BackingField>
  <_x003C_LoyaltyProgramBinRanges_x003E_k__BackingField>
    <LoyaltyProgramBinRangeDto>
      <BinRange>sample string 3</BinRange>
      <Id>a3de3e5b-ed71-4da6-afee-4a8266ef1c45</Id>
      <IdLoyaltyProgram>119e7b04-5c31-4860-b432-7f9f722ea05a</IdLoyaltyProgram>
      <LoyaltyProgramCode>sample string 4</LoyaltyProgramCode>
    </LoyaltyProgramBinRangeDto>
    <LoyaltyProgramBinRangeDto>
      <BinRange>sample string 3</BinRange>
      <Id>a3de3e5b-ed71-4da6-afee-4a8266ef1c45</Id>
      <IdLoyaltyProgram>119e7b04-5c31-4860-b432-7f9f722ea05a</IdLoyaltyProgram>
      <LoyaltyProgramCode>sample string 4</LoyaltyProgramCode>
    </LoyaltyProgramBinRangeDto>
  </_x003C_LoyaltyProgramBinRanges_x003E_k__BackingField>
  <_x003C_LoyaltyProgramEliteStatuses_x003E_k__BackingField>
    <LoyaltyProgramEliteStatusDto>
      <Active>true</Active>
      <Code>sample string 3</Code>
      <DateFrom>2025-04-25T16:40:24.5215003Z</DateFrom>
      <DateTo>2025-04-25T16:40:24.5215003Z</DateTo>
      <Id>beb9cfb2-d7e6-4a52-88b5-ff375725ca5b</Id>
      <IdLoyaltyProgram>d5659903-42d9-4961-b1da-fa611e8e783d</IdLoyaltyProgram>
      <Name>sample string 4</Name>
      <Type>64</Type>
    </LoyaltyProgramEliteStatusDto>
    <LoyaltyProgramEliteStatusDto>
      <Active>true</Active>
      <Code>sample string 3</Code>
      <DateFrom>2025-04-25T16:40:24.5215003Z</DateFrom>
      <DateTo>2025-04-25T16:40:24.5215003Z</DateTo>
      <Id>beb9cfb2-d7e6-4a52-88b5-ff375725ca5b</Id>
      <IdLoyaltyProgram>d5659903-42d9-4961-b1da-fa611e8e783d</IdLoyaltyProgram>
      <Name>sample string 4</Name>
      <Type>64</Type>
    </LoyaltyProgramEliteStatusDto>
  </_x003C_LoyaltyProgramEliteStatuses_x003E_k__BackingField>
  <_x003C_LoyaltyProgramRatio_x003E_k__BackingField>
    <LoyaltyProgramRatioDto>
      <Id>97a271ee-261a-4171-9b50-c75610bb825d</Id>
      <IdLoyaltyProgram>85fa85bf-057a-45d8-8079-d4f4d4eab6e1</IdLoyaltyProgram>
      <IdStockKeepingUnit>9e0bcb0a-d2e0-466b-9bfa-ca5ec0e01e6c</IdStockKeepingUnit>
      <Name>sample string 5</Name>
      <Type>4</Type>
      <loyaltyProgramRatioValidities>
        <LoyaltyProgramRatioValidityDto>
          <_x003C_AmountRatio_x003E_k__BackingField>4</_x003C_AmountRatio_x003E_k__BackingField>
          <_x003C_DateFrom_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateFrom_x003E_k__BackingField>
          <_x003C_DateTo_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateTo_x003E_k__BackingField>
          <_x003C_DiscountRatio_x003E_k__BackingField>6</_x003C_DiscountRatio_x003E_k__BackingField>
          <_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>2401308b-879b-4557-962b-542f74a25eb2</_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>
          <_x003C_Id_x003E_k__BackingField>450ed7bd-14ec-4f64-b7a9-98c4ec5430cc</_x003C_Id_x003E_k__BackingField>
          <_x003C_PointsRatio_x003E_k__BackingField>5</_x003C_PointsRatio_x003E_k__BackingField>
        </LoyaltyProgramRatioValidityDto>
        <LoyaltyProgramRatioValidityDto>
          <_x003C_AmountRatio_x003E_k__BackingField>4</_x003C_AmountRatio_x003E_k__BackingField>
          <_x003C_DateFrom_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateFrom_x003E_k__BackingField>
          <_x003C_DateTo_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateTo_x003E_k__BackingField>
          <_x003C_DiscountRatio_x003E_k__BackingField>6</_x003C_DiscountRatio_x003E_k__BackingField>
          <_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>2401308b-879b-4557-962b-542f74a25eb2</_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>
          <_x003C_Id_x003E_k__BackingField>450ed7bd-14ec-4f64-b7a9-98c4ec5430cc</_x003C_Id_x003E_k__BackingField>
          <_x003C_PointsRatio_x003E_k__BackingField>5</_x003C_PointsRatio_x003E_k__BackingField>
        </LoyaltyProgramRatioValidityDto>
      </loyaltyProgramRatioValidities>
    </LoyaltyProgramRatioDto>
    <LoyaltyProgramRatioDto>
      <Id>97a271ee-261a-4171-9b50-c75610bb825d</Id>
      <IdLoyaltyProgram>85fa85bf-057a-45d8-8079-d4f4d4eab6e1</IdLoyaltyProgram>
      <IdStockKeepingUnit>9e0bcb0a-d2e0-466b-9bfa-ca5ec0e01e6c</IdStockKeepingUnit>
      <Name>sample string 5</Name>
      <Type>4</Type>
      <loyaltyProgramRatioValidities>
        <LoyaltyProgramRatioValidityDto>
          <_x003C_AmountRatio_x003E_k__BackingField>4</_x003C_AmountRatio_x003E_k__BackingField>
          <_x003C_DateFrom_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateFrom_x003E_k__BackingField>
          <_x003C_DateTo_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateTo_x003E_k__BackingField>
          <_x003C_DiscountRatio_x003E_k__BackingField>6</_x003C_DiscountRatio_x003E_k__BackingField>
          <_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>2401308b-879b-4557-962b-542f74a25eb2</_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>
          <_x003C_Id_x003E_k__BackingField>450ed7bd-14ec-4f64-b7a9-98c4ec5430cc</_x003C_Id_x003E_k__BackingField>
          <_x003C_PointsRatio_x003E_k__BackingField>5</_x003C_PointsRatio_x003E_k__BackingField>
        </LoyaltyProgramRatioValidityDto>
        <LoyaltyProgramRatioValidityDto>
          <_x003C_AmountRatio_x003E_k__BackingField>4</_x003C_AmountRatio_x003E_k__BackingField>
          <_x003C_DateFrom_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateFrom_x003E_k__BackingField>
          <_x003C_DateTo_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_DateTo_x003E_k__BackingField>
          <_x003C_DiscountRatio_x003E_k__BackingField>6</_x003C_DiscountRatio_x003E_k__BackingField>
          <_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>2401308b-879b-4557-962b-542f74a25eb2</_x003C_IdLoyaltyProgramRatio_x003E_k__BackingField>
          <_x003C_Id_x003E_k__BackingField>450ed7bd-14ec-4f64-b7a9-98c4ec5430cc</_x003C_Id_x003E_k__BackingField>
          <_x003C_PointsRatio_x003E_k__BackingField>5</_x003C_PointsRatio_x003E_k__BackingField>
        </LoyaltyProgramRatioValidityDto>
      </loyaltyProgramRatioValidities>
    </LoyaltyProgramRatioDto>
  </_x003C_LoyaltyProgramRatio_x003E_k__BackingField>
  <_x003C_LoyaltyProgramsSites_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>065815f6-7a6e-4b8c-aa92-d8b17c786718</d2p1:guid>
    <d2p1:guid>c8853a50-b447-4e7e-b0d9-25e27f0a0ff8</d2p1:guid>
  </_x003C_LoyaltyProgramsSites_x003E_k__BackingField>
  <_x003C_LoyaltyProgramsZones_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>0bdf3227-170a-47fc-b718-cdeccde2e053</d2p1:guid>
    <d2p1:guid>a6c9123e-8136-40da-8bd1-02d063c4d58b</d2p1:guid>
  </_x003C_LoyaltyProgramsZones_x003E_k__BackingField>
  <_x003C_NotificationPointAlert_x003E_k__BackingField>1</_x003C_NotificationPointAlert_x003E_k__BackingField>
  <_x003C_Periodicity_x003E_k__BackingField>64</_x003C_Periodicity_x003E_k__BackingField>
  <_x003C_ProgramType_x003E_k__BackingField>64</_x003C_ProgramType_x003E_k__BackingField>
  <_x003C_RedemptionDiscount_x003E_k__BackingField>1</_x003C_RedemptionDiscount_x003E_k__BackingField>
  <_x003C_StartDate_x003E_k__BackingField>2025-04-25T16:40:24.2871219Z</_x003C_StartDate_x003E_k__BackingField>
  <_x003C_SupportPhoneNumber_x003E_k__BackingField>sample string 19</_x003C_SupportPhoneNumber_x003E_k__BackingField>
  <_x003C_SupportsDualIdentification_x003E_k__BackingField>true</_x003C_SupportsDualIdentification_x003E_k__BackingField>
  <_x003C_SupportsStockManagement_x003E_k__BackingField>true</_x003C_SupportsStockManagement_x003E_k__BackingField>
  <_x003C_TargetMembers_x003E_k__BackingField>7</_x003C_TargetMembers_x003E_k__BackingField>
</LoyaltyProgramDto>