GET Promotions/{SiteID}?PromoID={PromoID}&PromoType={PromoType}&PromoIsActive={PromoIsActive}&PromoGroupIsActive={PromoGroupIsActive}&PromoGroupProductIsActive={PromoGroupProductIsActive}
Gets A List Of All Promotions for Site given
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
None. |
|
| PromoID | integer |
None. |
|
| PromoType | integer |
None. |
|
| PromoIsActive | boolean |
None. |
|
| PromoGroupIsActive | boolean |
None. |
|
| PromoGroupProductIsActive | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
PromotionResultDto| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
None. |
|
| Promotions | Collection of PromoDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"SiteID": 1,
"Promotions": [
{
"PromoID": 1,
"PromoName": "sample string 2",
"StartDate": "2026-03-15T10:41:29.5273769",
"EndDate": "2026-03-15T10:41:29.5273769",
"PromoType": 3,
"PromoValue": 4.0,
"InputPromoGroups": [
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
},
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
}
],
"OutputPromoGroups": [
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
},
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
}
]
},
{
"PromoID": 1,
"PromoName": "sample string 2",
"StartDate": "2026-03-15T10:41:29.5273769",
"EndDate": "2026-03-15T10:41:29.5273769",
"PromoType": 3,
"PromoValue": 4.0,
"InputPromoGroups": [
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
},
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
}
],
"OutputPromoGroups": [
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
},
{
"PromoGroupID": 1,
"PromoID": 3,
"TriggerQty": 5,
"ActionValue": 6.0,
"IsActive": true,
"Products": [
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
},
{
"PromoGroupProductID": 1,
"ProductID": 4,
"MeasureID": 5,
"IsActive": true,
"AddOnPrice": 7.0
}
]
}
]
}
]
}
application/xml, text/xml
Sample:
<PromotionResultDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Promotions.Dtos">
<Promotions>
<PromoDto>
<EndDate>2026-03-15T10:41:29.5273769</EndDate>
<InputPromoGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroups.Dtos">
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
</InputPromoGroups>
<IsActive>true</IsActive>
<OutputPromoGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroups.Dtos">
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
</OutputPromoGroups>
<PromoID>1</PromoID>
<PromoName>sample string 2</PromoName>
<PromoType>3</PromoType>
<PromoValue>4</PromoValue>
<StartDate>2026-03-15T10:41:29.5273769</StartDate>
</PromoDto>
<PromoDto>
<EndDate>2026-03-15T10:41:29.5273769</EndDate>
<InputPromoGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroups.Dtos">
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
</InputPromoGroups>
<IsActive>true</IsActive>
<OutputPromoGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroups.Dtos">
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
<d4p1:PromoGroupDto>
<d4p1:ActionValue>6</d4p1:ActionValue>
<d4p1:IsActive>true</d4p1:IsActive>
<d4p1:IsInput>true</d4p1:IsInput>
<d4p1:Products xmlns:d6p1="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.PromotionGroupProducts.Dtos">
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
<d6p1:PromoGroupProductsDto>
<d6p1:AddOnPrice>7</d6p1:AddOnPrice>
<d6p1:IsActive>true</d6p1:IsActive>
<d6p1:MeasureID>5</d6p1:MeasureID>
<d6p1:ProductID>4</d6p1:ProductID>
<d6p1:PromoGroupID>3</d6p1:PromoGroupID>
<d6p1:PromoGroupProductID>1</d6p1:PromoGroupProductID>
<d6p1:SiteID>2</d6p1:SiteID>
</d6p1:PromoGroupProductsDto>
</d4p1:Products>
<d4p1:PromoGroupID>1</d4p1:PromoGroupID>
<d4p1:PromoID>3</d4p1:PromoID>
<d4p1:SiteID>2</d4p1:SiteID>
<d4p1:TriggerQty>5</d4p1:TriggerQty>
</d4p1:PromoGroupDto>
</OutputPromoGroups>
<PromoID>1</PromoID>
<PromoName>sample string 2</PromoName>
<PromoType>3</PromoType>
<PromoValue>4</PromoValue>
<StartDate>2026-03-15T10:41:29.5273769</StartDate>
</PromoDto>
</Promotions>
<SiteID>1</SiteID>
</PromotionResultDto>