GET api/Promotions

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Promotion

Name	Type	Additional information
Id	string	None.
Name	string	None.
DisplayName	string	None.
Stores	Collection of string	None.
PaymentMethods	Collection of string	None.
DaysOfMonth	Collection of integer	None.
DaysOfWeek	Collection of integer	None.
Hours	Collection of integer	None.
EffectiveStartDate	date	None.
EffectiveEndDate	date	None.
Conditions	Collection of PromotionCondition	None.
Exceptions	Collection of PromotionCondition	None.
Rewards	Collection of PromotionReward	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "Stores": [
      "sample string 1",
      "sample string 2"
    ],
    "PaymentMethods": [
      "sample string 1",
      "sample string 2"
    ],
    "DaysOfMonth": [
      1,
      2
    ],
    "DaysOfWeek": [
      1,
      2
    ],
    "Hours": [
      1,
      2
    ],
    "EffectiveStartDate": "2025-12-11T12:01:08.2205612-06:00",
    "EffectiveEndDate": "2025-12-11T12:01:08.2205612-06:00",
    "Conditions": [
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Exceptions": [
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Rewards": [
      {
        "Type": "sample string 1",
        "Value": "sample string 2",
        "Value2": "sample string 3"
      },
      {
        "Type": "sample string 1",
        "Value": "sample string 2",
        "Value2": "sample string 3"
      }
    ]
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "Stores": [
      "sample string 1",
      "sample string 2"
    ],
    "PaymentMethods": [
      "sample string 1",
      "sample string 2"
    ],
    "DaysOfMonth": [
      1,
      2
    ],
    "DaysOfWeek": [
      1,
      2
    ],
    "Hours": [
      1,
      2
    ],
    "EffectiveStartDate": "2025-12-11T12:01:08.2205612-06:00",
    "EffectiveEndDate": "2025-12-11T12:01:08.2205612-06:00",
    "Conditions": [
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Exceptions": [
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Type": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Rewards": [
      {
        "Type": "sample string 1",
        "Value": "sample string 2",
        "Value2": "sample string 3"
      },
      {
        "Type": "sample string 1",
        "Value": "sample string 2",
        "Value2": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPromotion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EnigmaSDK.Response">
  <Promotion>
    <Conditions>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
    </Conditions>
    <DaysOfMonth xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfMonth>
    <DaysOfWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfWeek>
    <DisplayName>sample string 3</DisplayName>
    <EffectiveEndDate>2025-12-11T12:01:08.2205612-06:00</EffectiveEndDate>
    <EffectiveStartDate>2025-12-11T12:01:08.2205612-06:00</EffectiveStartDate>
    <Exceptions>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
    </Exceptions>
    <Hours xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </Hours>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <PaymentMethods xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PaymentMethods>
    <Rewards>
      <PromotionReward>
        <Type>sample string 1</Type>
        <Value>sample string 2</Value>
        <Value2>sample string 3</Value2>
      </PromotionReward>
      <PromotionReward>
        <Type>sample string 1</Type>
        <Value>sample string 2</Value>
        <Value2>sample string 3</Value2>
      </PromotionReward>
    </Rewards>
    <Stores xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Stores>
  </Promotion>
  <Promotion>
    <Conditions>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
    </Conditions>
    <DaysOfMonth xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfMonth>
    <DaysOfWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfWeek>
    <DisplayName>sample string 3</DisplayName>
    <EffectiveEndDate>2025-12-11T12:01:08.2205612-06:00</EffectiveEndDate>
    <EffectiveStartDate>2025-12-11T12:01:08.2205612-06:00</EffectiveStartDate>
    <Exceptions>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
      <PromotionCondition>
        <Type>sample string 1</Type>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </PromotionCondition>
    </Exceptions>
    <Hours xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </Hours>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <PaymentMethods xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PaymentMethods>
    <Rewards>
      <PromotionReward>
        <Type>sample string 1</Type>
        <Value>sample string 2</Value>
        <Value2>sample string 3</Value2>
      </PromotionReward>
      <PromotionReward>
        <Type>sample string 1</Type>
        <Value>sample string 2</Value>
        <Value2>sample string 3</Value2>
      </PromotionReward>
    </Rewards>
    <Stores xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Stores>
  </Promotion>
</ArrayOfPromotion>