GET api/v1/promotions?categoryCode={categoryCode}&Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}&promotionChannelCode={promotionChannelCode}

Request Information

URI Parameters

Name	Type	Additional information
categoryCode	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": "118dc827-1e61-4860-8b86-e901d6ceeac3",
      "creationDate": "2025-08-31T09:02:57.7464119+00:00",
      "modificationDate": "2025-08-31T09:02:57.7464119+00:00",
      "code": "sample string 3",
      "urlImagePromotion": "sample string 4",
      "titleList": "sample string 5",
      "titleDetail": "sample string 6",
      "conditions": "sample string 7",
      "beginDate": "2025-08-31T09:02:57.7464119+00:00",
      "endDate": "2025-08-31T09:02:57.7464119+00:00",
      "beginUsableDate": "2025-08-31T09:02:57.7464119+00:00",
      "endUsableDate": "2025-08-31T09:02:57.7464119+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": "5a495636-dff1-4f47-a6c6-0266e2b27099",
          "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": "5a495636-dff1-4f47-a6c6-0266e2b27099",
          "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": "118dc827-1e61-4860-8b86-e901d6ceeac3",
      "creationDate": "2025-08-31T09:02:57.7464119+00:00",
      "modificationDate": "2025-08-31T09:02:57.7464119+00:00",
      "code": "sample string 3",
      "urlImagePromotion": "sample string 4",
      "titleList": "sample string 5",
      "titleDetail": "sample string 6",
      "conditions": "sample string 7",
      "beginDate": "2025-08-31T09:02:57.7464119+00:00",
      "endDate": "2025-08-31T09:02:57.7464119+00:00",
      "beginUsableDate": "2025-08-31T09:02:57.7464119+00:00",
      "endUsableDate": "2025-08-31T09:02:57.7464119+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": "5a495636-dff1-4f47-a6c6-0266e2b27099",
          "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": "5a495636-dff1-4f47-a6c6-0266e2b27099",
          "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>2025-08-31T09:02:57.7464119+00:00</d2p1:BeginDate>
      <d2p1:BeginUsableDate>2025-08-31T09:02:57.7464119+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>2025-08-31T09:02:57.7464119+00:00</d2p1:CreationDate>
      <d2p1:Description>sample string 9</d2p1:Description>
      <d2p1:DiscountValueEuros>1</d2p1:DiscountValueEuros>
      <d2p1:DiscountValuePercentage>1</d2p1:DiscountValuePercentage>
      <d2p1:EndDate>2025-08-31T09:02:57.7464119+00:00</d2p1:EndDate>
      <d2p1:EndUsableDate>2025-08-31T09:02:57.7464119+00:00</d2p1:EndUsableDate>
      <d2p1:Id>118dc827-1e61-4860-8b86-e901d6ceeac3</d2p1:Id>
      <d2p1:IsDeleteable>true</d2p1:IsDeleteable>
      <d2p1:IsHidden>true</d2p1:IsHidden>
      <d2p1:ModificationDate>2025-08-31T09:02:57.7464119+00:00</d2p1:ModificationDate>
      <d2p1:PartnerPromotions>
        <d2p1:PartnerPromotionDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:Email>sample string 6</d2p1:Email>
          <d2p1:Id>5a495636-dff1-4f47-a6c6-0266e2b27099</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>5a495636-dff1-4f47-a6c6-0266e2b27099</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>2025-08-31T09:02:57.7464119+00:00</d2p1:BeginDate>
      <d2p1:BeginUsableDate>2025-08-31T09:02:57.7464119+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>2025-08-31T09:02:57.7464119+00:00</d2p1:CreationDate>
      <d2p1:Description>sample string 9</d2p1:Description>
      <d2p1:DiscountValueEuros>1</d2p1:DiscountValueEuros>
      <d2p1:DiscountValuePercentage>1</d2p1:DiscountValuePercentage>
      <d2p1:EndDate>2025-08-31T09:02:57.7464119+00:00</d2p1:EndDate>
      <d2p1:EndUsableDate>2025-08-31T09:02:57.7464119+00:00</d2p1:EndUsableDate>
      <d2p1:Id>118dc827-1e61-4860-8b86-e901d6ceeac3</d2p1:Id>
      <d2p1:IsDeleteable>true</d2p1:IsDeleteable>
      <d2p1:IsHidden>true</d2p1:IsHidden>
      <d2p1:ModificationDate>2025-08-31T09:02:57.7464119+00:00</d2p1:ModificationDate>
      <d2p1:PartnerPromotions>
        <d2p1:PartnerPromotionDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:Email>sample string 6</d2p1:Email>
          <d2p1:Id>5a495636-dff1-4f47-a6c6-0266e2b27099</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>5a495636-dff1-4f47-a6c6-0266e2b27099</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>