GET api/Offers/{id}
Gets the offer details
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
OfferDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| OfferID | globally unique identifier |
None. |
|
| Title | string |
None. |
|
| HeaderText | string |
None. |
|
| DetailsText | string |
None. |
|
| PropertiesJSON | string |
None. |
|
| Operator | OperatorPreview |
None. |
|
| Supplier | SupplierPreview |
None. |
|
| Category | CategoryPreview |
None. |
|
| Status | OfferStatus |
None. |
|
| PurchaseAmount | decimal number |
None. |
|
| GrossAmount | decimal number |
None. |
|
| SalesAmount | decimal number |
None. |
|
| DiscountPercent | decimal number |
None. |
|
| ValidFrom | date |
None. |
|
| ValidTo | date |
None. |
|
| ItemsInStock | integer |
None. |
|
| ItemsAvailable | integer |
None. |
|
| IsProductionIncluded | boolean |
None. |
|
| IsAccessibleToAllOperators | boolean |
None. |
|
| IsAccessibleToAllSuppliers | boolean |
None. |
|
| IsPrivate | boolean |
None. |
|
| IsFeatured | boolean |
None. |
|
| Image1 | FilePreview |
None. |
|
| Image2 | FilePreview |
None. |
|
| Image3 | FilePreview |
None. |
|
| Image4 | FilePreview |
None. |
|
| Tags | string |
None. |
|
| CampaignStartDate | date |
None. |
|
| CampaignEndDate | date |
None. |
|
| CampaignNetReach | integer |
None. |
|
| ExcludedCustomers | Collection of CustomerPreview |
None. |
|
| CustomerViewCount | integer |
None. |
|
| AnonymousViewCount | integer |
None. |
|
| Notes | string |
None. |
|
| CreatedAt | date |
None. |
|
| CreatedBy | string |
None. |
|
| ModifiedAt | date |
None. |
|
| ModifiedBy | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"OfferID": "f432963c-9fc7-4657-b6bc-545cb1bdec36",
"Title": "sample string 2",
"HeaderText": "sample string 3",
"DetailsText": "sample string 4",
"PropertiesJSON": "sample string 5",
"Operator": {
"OperatorID": "bbe2eaa0-8275-4f1a-b39f-7d1959a8053e",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IetfLanguageTag": "sample string 4",
"PhoneNumber": "sample string 5",
"EmailAddress": "sample string 6",
"LogoBlobUrl": "sample string 7"
},
"Supplier": {
"SupplierID": "837a7128-7f12-418b-bea3-eb83fc208a4d",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"LogoBlobUrl": "sample string 5"
},
"Category": {
"CategoryID": "f1fdcd7d-4efb-4fe7-8a2d-3cd9d3132b0f",
"ParentName": "sample string 2",
"Name": "sample string 3"
},
"Status": "InActive",
"PurchaseAmount": 1.1,
"GrossAmount": 6.1,
"SalesAmount": 7.1,
"DiscountPercent": 8.1,
"ValidFrom": "2026-04-11T02:53:58.8562431Z",
"ValidTo": "2026-04-11T02:53:58.8562431Z",
"ItemsInStock": 11,
"ItemsAvailable": 12,
"IsProductionIncluded": true,
"IsAccessibleToAllOperators": true,
"IsAccessibleToAllSuppliers": true,
"IsPrivate": true,
"IsFeatured": true,
"Image1": {
"FileID": "fa019466-7917-47ff-aa39-3acaa4c6c937",
"LinkedEntityID": "b4a14c87-2598-40a7-bcde-fa867910df7a",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "sample string 5"
},
"Image2": {
"FileID": "fa019466-7917-47ff-aa39-3acaa4c6c937",
"LinkedEntityID": "b4a14c87-2598-40a7-bcde-fa867910df7a",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "sample string 5"
},
"Image3": {
"FileID": "fa019466-7917-47ff-aa39-3acaa4c6c937",
"LinkedEntityID": "b4a14c87-2598-40a7-bcde-fa867910df7a",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "sample string 5"
},
"Image4": {
"FileID": "fa019466-7917-47ff-aa39-3acaa4c6c937",
"LinkedEntityID": "b4a14c87-2598-40a7-bcde-fa867910df7a",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "sample string 5"
},
"Tags": "sample string 18",
"CampaignStartDate": "2026-04-11T02:53:58.8562431Z",
"CampaignEndDate": "2026-04-11T02:53:58.8562431Z",
"CampaignNetReach": 21,
"ExcludedCustomers": [
{
"CustomerID": "dc4b93b5-2426-49c6-9380-c0da399e9d56",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"City": "sample string 5",
"PostalCode": "sample string 6",
"Country": "sample string 7",
"IsBackendCustomer": true,
"LogoBlobUrl": "sample string 9"
},
{
"CustomerID": "dc4b93b5-2426-49c6-9380-c0da399e9d56",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"City": "sample string 5",
"PostalCode": "sample string 6",
"Country": "sample string 7",
"IsBackendCustomer": true,
"LogoBlobUrl": "sample string 9"
}
],
"CustomerViewCount": 22,
"AnonymousViewCount": 23,
"Notes": "sample string 24",
"CreatedAt": "2026-04-11T02:53:58.8562431Z",
"CreatedBy": "sample string 26",
"ModifiedAt": "2026-04-11T02:53:58.8562431Z",
"ModifiedBy": "sample string 28"
}
application/xml, text/xml
Sample:
<OfferDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
<AnonymousViewCount>23</AnonymousViewCount>
<CampaignEndDate>2026-04-11T02:53:58.8562431+00:00</CampaignEndDate>
<CampaignNetReach>21</CampaignNetReach>
<CampaignStartDate>2026-04-11T02:53:58.8562431+00:00</CampaignStartDate>
<Category>
<CategoryID>f1fdcd7d-4efb-4fe7-8a2d-3cd9d3132b0f</CategoryID>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
</Category>
<CreatedAt>2026-04-11T02:53:58.8562431+00:00</CreatedAt>
<CreatedBy>sample string 26</CreatedBy>
<CustomerViewCount>22</CustomerViewCount>
<DetailsText>sample string 4</DetailsText>
<DiscountPercent>8.1</DiscountPercent>
<ExcludedCustomers>
<CustomerPreview>
<Address>sample string 4</Address>
<City>sample string 5</City>
<Country>sample string 7</Country>
<CustomerID>dc4b93b5-2426-49c6-9380-c0da399e9d56</CustomerID>
<IsBackendCustomer>true</IsBackendCustomer>
<LogoBlobUrl>sample string 9</LogoBlobUrl>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PostalCode>sample string 6</PostalCode>
<Status>InActive</Status>
</CustomerPreview>
<CustomerPreview>
<Address>sample string 4</Address>
<City>sample string 5</City>
<Country>sample string 7</Country>
<CustomerID>dc4b93b5-2426-49c6-9380-c0da399e9d56</CustomerID>
<IsBackendCustomer>true</IsBackendCustomer>
<LogoBlobUrl>sample string 9</LogoBlobUrl>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PostalCode>sample string 6</PostalCode>
<Status>InActive</Status>
</CustomerPreview>
</ExcludedCustomers>
<GrossAmount>6.1</GrossAmount>
<HeaderText>sample string 3</HeaderText>
<Image1>
<BlobUrl>sample string 5</BlobUrl>
<FileID>fa019466-7917-47ff-aa39-3acaa4c6c937</FileID>
<FileName>sample string 4</FileName>
<LinkedEntityID>b4a14c87-2598-40a7-bcde-fa867910df7a</LinkedEntityID>
<LinkedPropertyName>sample string 3</LinkedPropertyName>
</Image1>
<Image2>
<BlobUrl>sample string 5</BlobUrl>
<FileID>fa019466-7917-47ff-aa39-3acaa4c6c937</FileID>
<FileName>sample string 4</FileName>
<LinkedEntityID>b4a14c87-2598-40a7-bcde-fa867910df7a</LinkedEntityID>
<LinkedPropertyName>sample string 3</LinkedPropertyName>
</Image2>
<Image3>
<BlobUrl>sample string 5</BlobUrl>
<FileID>fa019466-7917-47ff-aa39-3acaa4c6c937</FileID>
<FileName>sample string 4</FileName>
<LinkedEntityID>b4a14c87-2598-40a7-bcde-fa867910df7a</LinkedEntityID>
<LinkedPropertyName>sample string 3</LinkedPropertyName>
</Image3>
<Image4>
<BlobUrl>sample string 5</BlobUrl>
<FileID>fa019466-7917-47ff-aa39-3acaa4c6c937</FileID>
<FileName>sample string 4</FileName>
<LinkedEntityID>b4a14c87-2598-40a7-bcde-fa867910df7a</LinkedEntityID>
<LinkedPropertyName>sample string 3</LinkedPropertyName>
</Image4>
<IsAccessibleToAllOperators>true</IsAccessibleToAllOperators>
<IsAccessibleToAllSuppliers>true</IsAccessibleToAllSuppliers>
<IsFeatured>true</IsFeatured>
<IsPrivate>true</IsPrivate>
<IsProductionIncluded>true</IsProductionIncluded>
<ItemsAvailable>12</ItemsAvailable>
<ItemsInStock>11</ItemsInStock>
<ModifiedAt>2026-04-11T02:53:58.8562431+00:00</ModifiedAt>
<ModifiedBy>sample string 28</ModifiedBy>
<Notes>sample string 24</Notes>
<OfferID>f432963c-9fc7-4657-b6bc-545cb1bdec36</OfferID>
<Operator>
<EmailAddress>sample string 6</EmailAddress>
<IetfLanguageTag>sample string 4</IetfLanguageTag>
<LogoBlobUrl>sample string 7</LogoBlobUrl>
<Name>sample string 3</Name>
<OperatorID>bbe2eaa0-8275-4f1a-b39f-7d1959a8053e</OperatorID>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 5</PhoneNumber>
<Status>InActive</Status>
</Operator>
<PropertiesJSON>sample string 5</PropertiesJSON>
<PurchaseAmount>1.1</PurchaseAmount>
<SalesAmount>7.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>837a7128-7f12-418b-bea3-eb83fc208a4d</SupplierID>
</Supplier>
<Tags>sample string 18</Tags>
<Title>sample string 2</Title>
<ValidFrom>2026-04-11T02:53:58.8562431+00:00</ValidFrom>
<ValidTo>2026-04-11T02:53:58.8562431+00:00</ValidTo>
</OfferDetail>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OfferID" f432963c-9fc7-4657-b6bc-545cb1bdec36 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Title" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="HeaderText" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DetailsText" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PropertiesJSON" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.OperatorID" bbe2eaa0-8275-4f1a-b39f-7d1959a8053e --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.IetfLanguageTag" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.PhoneNumber" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.EmailAddress" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.LogoBlobUrl" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Supplier.SupplierID" 837a7128-7f12-418b-bea3-eb83fc208a4d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Supplier.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Supplier.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Supplier.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Supplier.IsBackendSupplier" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Supplier.LogoBlobUrl" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Category.CategoryID" f1fdcd7d-4efb-4fe7-8a2d-3cd9d3132b0f --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Category.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Category.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PurchaseAmount" 1,1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GrossAmount" 6,1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SalesAmount" 7,1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DiscountPercent" 8,1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ValidFrom" 2026-04-11T02:53:58.8562431+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ValidTo" 2026-04-11T02:53:58.8562431+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ItemsInStock" 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ItemsAvailable" 12 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsProductionIncluded" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsAccessibleToAllOperators" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsAccessibleToAllSuppliers" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsPrivate" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsFeatured" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image1.FileID" fa019466-7917-47ff-aa39-3acaa4c6c937 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image1.LinkedEntityID" b4a14c87-2598-40a7-bcde-fa867910df7a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image1.LinkedPropertyName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image1.FileName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image1.BlobUrl" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image2.FileID" fa019466-7917-47ff-aa39-3acaa4c6c937 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image2.LinkedEntityID" b4a14c87-2598-40a7-bcde-fa867910df7a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image2.LinkedPropertyName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image2.FileName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image2.BlobUrl" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image3.FileID" fa019466-7917-47ff-aa39-3acaa4c6c937 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image3.LinkedEntityID" b4a14c87-2598-40a7-bcde-fa867910df7a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image3.LinkedPropertyName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image3.FileName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image3.BlobUrl" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image4.FileID" fa019466-7917-47ff-aa39-3acaa4c6c937 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image4.LinkedEntityID" b4a14c87-2598-40a7-bcde-fa867910df7a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image4.LinkedPropertyName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image4.FileName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image4.BlobUrl" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Tags" sample string 18 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CampaignStartDate" 2026-04-11T02:53:58.8562431+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CampaignEndDate" 2026-04-11T02:53:58.8562431+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CampaignNetReach" 21 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].CustomerID" dc4b93b5-2426-49c6-9380-c0da399e9d56 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].City" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].PostalCode" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].Country" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].IsBackendCustomer" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[0].LogoBlobUrl" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].CustomerID" dc4b93b5-2426-49c6-9380-c0da399e9d56 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].City" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].PostalCode" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].Country" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].IsBackendCustomer" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ExcludedCustomers[1].LogoBlobUrl" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomerViewCount" 22 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AnonymousViewCount" 23 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 24 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedAt" 2026-04-11T02:53:58.8562431+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 26 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-04-11T02:53:58.8562431+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 28 --MultipartDataMediaFormatterBoundary1q2w3e--