GET api/v1/promotions?searchText={searchText}&Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}&promotionChannelCode={promotionChannelCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| searchText | string |
Required |
|
| Limit | integer |
None. |
|
| Offset | integer |
None. |
|
| OrderBy | string |
None. |
|
| promotionChannelCode | string |
None. |
Body Parameters
None.
Response Information
Resource Description
MultiResultResponseOfPromotionDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Meta | MetaMultiResult |
None. |
|
| Notifications |
None. |
Response Formats
application/json, text/json
Sample:
{
"meta": {
"limit": 1,
"offset": 2,
"totalResults": 3
},
"notifications": [
{},
{}
],
"results": [
{
"id": "5189fedc-6d68-48a2-9bc3-185886c997cd",
"creationDate": "2026-02-04T04:34:46.5155214+00:00",
"modificationDate": "2026-02-04T04:34:46.5155214+00:00",
"code": "sample string 3",
"urlImagePromotion": "sample string 4",
"titleList": "sample string 5",
"titleDetail": "sample string 6",
"conditions": "sample string 7",
"beginDate": "2026-02-04T04:34:46.5155214+00:00",
"endDate": "2026-02-04T04:34:46.5155214+00:00",
"beginUsableDate": "2026-02-04T04:34:46.5155214+00:00",
"endUsableDate": "2026-02-04T04:34:46.5155214+00:00",
"promotionTypeCode": "sample string 8",
"description": "sample string 9",
"active": true,
"isHidden": true,
"categoryCode": "sample string 12",
"brandCode": "sample string 13",
"isDeleteable": true,
"partnerPromotions": [
{
"id": "7a94e9f6-c725-45f8-a472-694ca0063d14",
"code": "sample string 1",
"promotionCode": "sample string 2",
"name": "sample string 3",
"mobilePhone": "sample string 4",
"phone": "sample string 5",
"email": "sample string 6"
},
{
"id": "7a94e9f6-c725-45f8-a472-694ca0063d14",
"code": "sample string 1",
"promotionCode": "sample string 2",
"name": "sample string 3",
"mobilePhone": "sample string 4",
"phone": "sample string 5",
"email": "sample string 6"
}
],
"productsPromotions": "sample string 15",
"discountValueEuros": 1.0,
"discountValuePercentage": 1.0
},
{
"id": "5189fedc-6d68-48a2-9bc3-185886c997cd",
"creationDate": "2026-02-04T04:34:46.5155214+00:00",
"modificationDate": "2026-02-04T04:34:46.5155214+00:00",
"code": "sample string 3",
"urlImagePromotion": "sample string 4",
"titleList": "sample string 5",
"titleDetail": "sample string 6",
"conditions": "sample string 7",
"beginDate": "2026-02-04T04:34:46.5155214+00:00",
"endDate": "2026-02-04T04:34:46.5155214+00:00",
"beginUsableDate": "2026-02-04T04:34:46.5155214+00:00",
"endUsableDate": "2026-02-04T04:34:46.5155214+00:00",
"promotionTypeCode": "sample string 8",
"description": "sample string 9",
"active": true,
"isHidden": true,
"categoryCode": "sample string 12",
"brandCode": "sample string 13",
"isDeleteable": true,
"partnerPromotions": [
{
"id": "7a94e9f6-c725-45f8-a472-694ca0063d14",
"code": "sample string 1",
"promotionCode": "sample string 2",
"name": "sample string 3",
"mobilePhone": "sample string 4",
"phone": "sample string 5",
"email": "sample string 6"
},
{
"id": "7a94e9f6-c725-45f8-a472-694ca0063d14",
"code": "sample string 1",
"promotionCode": "sample string 2",
"name": "sample string 3",
"mobilePhone": "sample string 4",
"phone": "sample string 5",
"email": "sample string 6"
}
],
"productsPromotions": "sample string 15",
"discountValueEuros": 1.0,
"discountValuePercentage": 1.0
}
]
}
application/xml, text/xml
Sample:
<MultiResultResponseOfPromotionDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
<Meta>
<Limit>1</Limit>
<Offset>2</Offset>
<TotalResults>3</TotalResults>
</Meta>
<Notifications>
<Notification />
<Notification />
</Notifications>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
<d2p1:PromotionDto>
<d2p1:Active>true</d2p1:Active>
<d2p1:BeginDate>2026-02-04T04:34:46.5155214+00:00</d2p1:BeginDate>
<d2p1:BeginUsableDate>2026-02-04T04:34:46.5155214+00:00</d2p1:BeginUsableDate>
<d2p1:BrandCode>sample string 13</d2p1:BrandCode>
<d2p1:CategoryCode>sample string 12</d2p1:CategoryCode>
<d2p1:Code>sample string 3</d2p1:Code>
<d2p1:Conditions>sample string 7</d2p1:Conditions>
<d2p1:CreationDate>2026-02-04T04:34:46.5155214+00:00</d2p1:CreationDate>
<d2p1:Description>sample string 9</d2p1:Description>
<d2p1:DiscountValueEuros>1</d2p1:DiscountValueEuros>
<d2p1:DiscountValuePercentage>1</d2p1:DiscountValuePercentage>
<d2p1:EndDate>2026-02-04T04:34:46.5155214+00:00</d2p1:EndDate>
<d2p1:EndUsableDate>2026-02-04T04:34:46.5155214+00:00</d2p1:EndUsableDate>
<d2p1:Id>5189fedc-6d68-48a2-9bc3-185886c997cd</d2p1:Id>
<d2p1:IsDeleteable>true</d2p1:IsDeleteable>
<d2p1:IsHidden>true</d2p1:IsHidden>
<d2p1:ModificationDate>2026-02-04T04:34:46.5155214+00:00</d2p1:ModificationDate>
<d2p1:PartnerPromotions>
<d2p1:PartnerPromotionDto>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:Email>sample string 6</d2p1:Email>
<d2p1:Id>7a94e9f6-c725-45f8-a472-694ca0063d14</d2p1:Id>
<d2p1:MobilePhone>sample string 4</d2p1:MobilePhone>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:PromotionCode>sample string 2</d2p1:PromotionCode>
</d2p1:PartnerPromotionDto>
<d2p1:PartnerPromotionDto>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:Email>sample string 6</d2p1:Email>
<d2p1:Id>7a94e9f6-c725-45f8-a472-694ca0063d14</d2p1:Id>
<d2p1:MobilePhone>sample string 4</d2p1:MobilePhone>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:PromotionCode>sample string 2</d2p1:PromotionCode>
</d2p1:PartnerPromotionDto>
</d2p1:PartnerPromotions>
<d2p1:ProductsPromotions>sample string 15</d2p1:ProductsPromotions>
<d2p1:PromotionTypeCode>sample string 8</d2p1:PromotionTypeCode>
<d2p1:TitleDetail>sample string 6</d2p1:TitleDetail>
<d2p1:TitleList>sample string 5</d2p1:TitleList>
<d2p1:UrlImagePromotion>sample string 4</d2p1:UrlImagePromotion>
</d2p1:PromotionDto>
<d2p1:PromotionDto>
<d2p1:Active>true</d2p1:Active>
<d2p1:BeginDate>2026-02-04T04:34:46.5155214+00:00</d2p1:BeginDate>
<d2p1:BeginUsableDate>2026-02-04T04:34:46.5155214+00:00</d2p1:BeginUsableDate>
<d2p1:BrandCode>sample string 13</d2p1:BrandCode>
<d2p1:CategoryCode>sample string 12</d2p1:CategoryCode>
<d2p1:Code>sample string 3</d2p1:Code>
<d2p1:Conditions>sample string 7</d2p1:Conditions>
<d2p1:CreationDate>2026-02-04T04:34:46.5155214+00:00</d2p1:CreationDate>
<d2p1:Description>sample string 9</d2p1:Description>
<d2p1:DiscountValueEuros>1</d2p1:DiscountValueEuros>
<d2p1:DiscountValuePercentage>1</d2p1:DiscountValuePercentage>
<d2p1:EndDate>2026-02-04T04:34:46.5155214+00:00</d2p1:EndDate>
<d2p1:EndUsableDate>2026-02-04T04:34:46.5155214+00:00</d2p1:EndUsableDate>
<d2p1:Id>5189fedc-6d68-48a2-9bc3-185886c997cd</d2p1:Id>
<d2p1:IsDeleteable>true</d2p1:IsDeleteable>
<d2p1:IsHidden>true</d2p1:IsHidden>
<d2p1:ModificationDate>2026-02-04T04:34:46.5155214+00:00</d2p1:ModificationDate>
<d2p1:PartnerPromotions>
<d2p1:PartnerPromotionDto>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:Email>sample string 6</d2p1:Email>
<d2p1:Id>7a94e9f6-c725-45f8-a472-694ca0063d14</d2p1:Id>
<d2p1:MobilePhone>sample string 4</d2p1:MobilePhone>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:PromotionCode>sample string 2</d2p1:PromotionCode>
</d2p1:PartnerPromotionDto>
<d2p1:PartnerPromotionDto>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:Email>sample string 6</d2p1:Email>
<d2p1:Id>7a94e9f6-c725-45f8-a472-694ca0063d14</d2p1:Id>
<d2p1:MobilePhone>sample string 4</d2p1:MobilePhone>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:PromotionCode>sample string 2</d2p1:PromotionCode>
</d2p1:PartnerPromotionDto>
</d2p1:PartnerPromotions>
<d2p1:ProductsPromotions>sample string 15</d2p1:ProductsPromotions>
<d2p1:PromotionTypeCode>sample string 8</d2p1:PromotionTypeCode>
<d2p1:TitleDetail>sample string 6</d2p1:TitleDetail>
<d2p1:TitleList>sample string 5</d2p1:TitleList>
<d2p1:UrlImagePromotion>sample string 4</d2p1:UrlImagePromotion>
</d2p1:PromotionDto>
</Results>
</MultiResultResponseOfPromotionDtoaM_S85dVU>