GET Api/Offers/Featured?operatorID={operatorID}&take={take}

Gets a list of featured offers

Request Information

URI Parameters

Name	Description	Type	Additional information
operatorID	Optional, for anonymous use only	globally unique identifier	None.
take	Returns a specified number of contiguous elements from the start of a sequence	integer	Default value is 3

Body Parameters

None.

Response Information

Resource Description

Collection of OfferPreview

Name	Type	Additional information
OfferID	globally unique identifier	None.
Title	string	None.
GrossAmount	decimal number	None.
SalesAmount	decimal number	None.
DiscountPercent	decimal number	None.
Supplier	SupplierPreview	None.
Category	CategoryPreview	None.
Status	OfferStatus	None.
HeaderText	string	None.
IsProductionIncluded	boolean	None.
ItemsAvailable	integer	None.
Image1BlobUrl	string	None.
ValidFrom	date	None.
ValidTo	date	None.
IsPrivate	boolean	None.
IsFeatured	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OfferID": "dc14b3c0-5eaa-432e-beb4-4a6ace065bc4",
    "Title": "sample string 2",
    "GrossAmount": 3.1,
    "SalesAmount": 4.1,
    "DiscountPercent": 5.1,
    "Supplier": {
      "SupplierID": "392b36a4-4f4a-4b52-87fc-0bb6ec08561a",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "IsBackendSupplier": true,
      "LogoBlobUrl": "sample string 5"
    },
    "Category": {
      "CategoryID": "2434cb19-b533-4c24-bcdd-b6169a3f931f",
      "ParentName": "sample string 2",
      "Name": "sample string 3"
    },
    "Status": "InActive",
    "HeaderText": "sample string 6",
    "IsProductionIncluded": true,
    "ItemsAvailable": 8,
    "Image1BlobUrl": "sample string 9",
    "ValidFrom": "2026-04-11T03:02:20.8188653Z",
    "ValidTo": "2026-04-11T03:02:20.8188653Z",
    "IsPrivate": true,
    "IsFeatured": true
  },
  {
    "OfferID": "dc14b3c0-5eaa-432e-beb4-4a6ace065bc4",
    "Title": "sample string 2",
    "GrossAmount": 3.1,
    "SalesAmount": 4.1,
    "DiscountPercent": 5.1,
    "Supplier": {
      "SupplierID": "392b36a4-4f4a-4b52-87fc-0bb6ec08561a",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "IsBackendSupplier": true,
      "LogoBlobUrl": "sample string 5"
    },
    "Category": {
      "CategoryID": "2434cb19-b533-4c24-bcdd-b6169a3f931f",
      "ParentName": "sample string 2",
      "Name": "sample string 3"
    },
    "Status": "InActive",
    "HeaderText": "sample string 6",
    "IsProductionIncluded": true,
    "ItemsAvailable": 8,
    "Image1BlobUrl": "sample string 9",
    "ValidFrom": "2026-04-11T03:02:20.8188653Z",
    "ValidTo": "2026-04-11T03:02:20.8188653Z",
    "IsPrivate": true,
    "IsFeatured": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfOfferPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
  <OfferPreview>
    <Category>
      <CategoryID>2434cb19-b533-4c24-bcdd-b6169a3f931f</CategoryID>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
    </Category>
    <DiscountPercent>5.1</DiscountPercent>
    <GrossAmount>3.1</GrossAmount>
    <HeaderText>sample string 6</HeaderText>
    <Image1BlobUrl>sample string 9</Image1BlobUrl>
    <IsFeatured>true</IsFeatured>
    <IsPrivate>true</IsPrivate>
    <IsProductionIncluded>true</IsProductionIncluded>
    <ItemsAvailable>8</ItemsAvailable>
    <OfferID>dc14b3c0-5eaa-432e-beb4-4a6ace065bc4</OfferID>
    <SalesAmount>4.1</SalesAmount>
    <Status>InActive</Status>
    <Supplier>
      <IsBackendSupplier>true</IsBackendSupplier>
      <LogoBlobUrl>sample string 5</LogoBlobUrl>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <Status>InActive</Status>
      <SupplierID>392b36a4-4f4a-4b52-87fc-0bb6ec08561a</SupplierID>
    </Supplier>
    <Title>sample string 2</Title>
    <ValidFrom>2026-04-11T03:02:20.8188653+00:00</ValidFrom>
    <ValidTo>2026-04-11T03:02:20.8188653+00:00</ValidTo>
  </OfferPreview>
  <OfferPreview>
    <Category>
      <CategoryID>2434cb19-b533-4c24-bcdd-b6169a3f931f</CategoryID>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
    </Category>
    <DiscountPercent>5.1</DiscountPercent>
    <GrossAmount>3.1</GrossAmount>
    <HeaderText>sample string 6</HeaderText>
    <Image1BlobUrl>sample string 9</Image1BlobUrl>
    <IsFeatured>true</IsFeatured>
    <IsPrivate>true</IsPrivate>
    <IsProductionIncluded>true</IsProductionIncluded>
    <ItemsAvailable>8</ItemsAvailable>
    <OfferID>dc14b3c0-5eaa-432e-beb4-4a6ace065bc4</OfferID>
    <SalesAmount>4.1</SalesAmount>
    <Status>InActive</Status>
    <Supplier>
      <IsBackendSupplier>true</IsBackendSupplier>
      <LogoBlobUrl>sample string 5</LogoBlobUrl>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <Status>InActive</Status>
      <SupplierID>392b36a4-4f4a-4b52-87fc-0bb6ec08561a</SupplierID>
    </Supplier>
    <Title>sample string 2</Title>
    <ValidFrom>2026-04-11T03:02:20.8188653+00:00</ValidFrom>
    <ValidTo>2026-04-11T03:02:20.8188653+00:00</ValidTo>
  </OfferPreview>
</ArrayOfOfferPreview>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].OfferID"

dc14b3c0-5eaa-432e-beb4-4a6ace065bc4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Title"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].GrossAmount"

3,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].SalesAmount"

4,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].DiscountPercent"

5,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.SupplierID"

392b36a4-4f4a-4b52-87fc-0bb6ec08561a
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.IsBackendSupplier"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.LogoBlobUrl"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Category.CategoryID"

2434cb19-b533-4c24-bcdd-b6169a3f931f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Category.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Category.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].HeaderText"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsProductionIncluded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].ItemsAvailable"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Image1BlobUrl"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].ValidFrom"

2026-04-11T03:02:20.8188653+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].ValidTo"

2026-04-11T03:02:20.8188653+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsPrivate"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsFeatured"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].OfferID"

dc14b3c0-5eaa-432e-beb4-4a6ace065bc4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Title"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].GrossAmount"

3,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].SalesAmount"

4,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].DiscountPercent"

5,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.SupplierID"

392b36a4-4f4a-4b52-87fc-0bb6ec08561a
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.IsBackendSupplier"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.LogoBlobUrl"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Category.CategoryID"

2434cb19-b533-4c24-bcdd-b6169a3f931f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Category.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Category.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].HeaderText"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsProductionIncluded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].ItemsAvailable"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Image1BlobUrl"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].ValidFrom"

2026-04-11T03:02:20.8188653+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].ValidTo"

2026-04-11T03:02:20.8188653+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsPrivate"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsFeatured"

True
--MultipartDataMediaFormatterBoundary1q2w3e--