POST api/TillMenu/FollowOnProducts
Returns a collection of follow-on products. These are products that pop-up after a product is added to the basket.
Request Information
URI Parameters
None.
Body Parameters
EskimoClassLibraries.clsPaginationSettingsWithDate| Name | Description | Type | Additional information |
|---|---|---|---|
| DateFrom | date |
Required |
|
| PageRequired | integer |
Required Range: inclusive between 1 and 2147483647 |
|
| PageSize | integer |
Required Range: inclusive between 1 and 2147483647 |
Request Formats
application/json, text/json
Sample:
{
"DateFrom": "2024-05-03T09:06:09.2459127+01:00",
"PageRequired": 2,
"PageSize": 3
}
application/xml, text/xml
Sample:
<clsPaginationSettingsWithDate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries"> <PageRequired>2</PageRequired> <PageSize>3</PageSize> <DateFrom>2024-05-03T09:06:09.2459127+01:00</DateFrom> </clsPaginationSettingsWithDate>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of EskimoClassLibraries.clsTillMenuFollowOnProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| MasterPLU | string |
Required |
|
| Items | Collection of EskimoClassLibraries.clsTillMenuFollowOnProductDetail |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"MasterPLU": "sample string 1",
"Items": [
{
"DetailID": 1,
"PLU": "sample string 2",
"Description": "sample string 3",
"OrderBy": 4,
"Qty": 5,
"Notes": "sample string 6",
"Grouping": 1,
"Price": 1.0,
"TaxID": 7,
"ColourName": "sample string 8",
"IsOpenPriced": true,
"StockLevel": 10,
"StockWarnLevel": 1,
"Size": "sample string 11",
"NoDiscountAllowed": true
},
{
"DetailID": 1,
"PLU": "sample string 2",
"Description": "sample string 3",
"OrderBy": 4,
"Qty": 5,
"Notes": "sample string 6",
"Grouping": 1,
"Price": 1.0,
"TaxID": 7,
"ColourName": "sample string 8",
"IsOpenPriced": true,
"StockLevel": 10,
"StockWarnLevel": 1,
"Size": "sample string 11",
"NoDiscountAllowed": true
}
]
},
{
"MasterPLU": "sample string 1",
"Items": [
{
"DetailID": 1,
"PLU": "sample string 2",
"Description": "sample string 3",
"OrderBy": 4,
"Qty": 5,
"Notes": "sample string 6",
"Grouping": 1,
"Price": 1.0,
"TaxID": 7,
"ColourName": "sample string 8",
"IsOpenPriced": true,
"StockLevel": 10,
"StockWarnLevel": 1,
"Size": "sample string 11",
"NoDiscountAllowed": true
},
{
"DetailID": 1,
"PLU": "sample string 2",
"Description": "sample string 3",
"OrderBy": 4,
"Qty": 5,
"Notes": "sample string 6",
"Grouping": 1,
"Price": 1.0,
"TaxID": 7,
"ColourName": "sample string 8",
"IsOpenPriced": true,
"StockLevel": 10,
"StockWarnLevel": 1,
"Size": "sample string 11",
"NoDiscountAllowed": true
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfclsTillMenuFollowOnProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
<clsTillMenuFollowOnProduct>
<Items>
<clsTillMenuFollowOnProductDetail>
<ColourName>sample string 8</ColourName>
<Description>sample string 3</Description>
<DetailID>1</DetailID>
<Grouping>NotPartOfGroup</Grouping>
<IsOpenPriced>true</IsOpenPriced>
<NoDiscountAllowed>true</NoDiscountAllowed>
<Notes>sample string 6</Notes>
<OrderBy>4</OrderBy>
<PLU>sample string 2</PLU>
<Price>1</Price>
<Qty>5</Qty>
<Size>sample string 11</Size>
<StockLevel>10</StockLevel>
<StockWarnLevel>1</StockWarnLevel>
<TaxID>7</TaxID>
</clsTillMenuFollowOnProductDetail>
<clsTillMenuFollowOnProductDetail>
<ColourName>sample string 8</ColourName>
<Description>sample string 3</Description>
<DetailID>1</DetailID>
<Grouping>NotPartOfGroup</Grouping>
<IsOpenPriced>true</IsOpenPriced>
<NoDiscountAllowed>true</NoDiscountAllowed>
<Notes>sample string 6</Notes>
<OrderBy>4</OrderBy>
<PLU>sample string 2</PLU>
<Price>1</Price>
<Qty>5</Qty>
<Size>sample string 11</Size>
<StockLevel>10</StockLevel>
<StockWarnLevel>1</StockWarnLevel>
<TaxID>7</TaxID>
</clsTillMenuFollowOnProductDetail>
</Items>
<MasterPLU>sample string 1</MasterPLU>
</clsTillMenuFollowOnProduct>
<clsTillMenuFollowOnProduct>
<Items>
<clsTillMenuFollowOnProductDetail>
<ColourName>sample string 8</ColourName>
<Description>sample string 3</Description>
<DetailID>1</DetailID>
<Grouping>NotPartOfGroup</Grouping>
<IsOpenPriced>true</IsOpenPriced>
<NoDiscountAllowed>true</NoDiscountAllowed>
<Notes>sample string 6</Notes>
<OrderBy>4</OrderBy>
<PLU>sample string 2</PLU>
<Price>1</Price>
<Qty>5</Qty>
<Size>sample string 11</Size>
<StockLevel>10</StockLevel>
<StockWarnLevel>1</StockWarnLevel>
<TaxID>7</TaxID>
</clsTillMenuFollowOnProductDetail>
<clsTillMenuFollowOnProductDetail>
<ColourName>sample string 8</ColourName>
<Description>sample string 3</Description>
<DetailID>1</DetailID>
<Grouping>NotPartOfGroup</Grouping>
<IsOpenPriced>true</IsOpenPriced>
<NoDiscountAllowed>true</NoDiscountAllowed>
<Notes>sample string 6</Notes>
<OrderBy>4</OrderBy>
<PLU>sample string 2</PLU>
<Price>1</Price>
<Qty>5</Qty>
<Size>sample string 11</Size>
<StockLevel>10</StockLevel>
<StockWarnLevel>1</StockWarnLevel>
<TaxID>7</TaxID>
</clsTillMenuFollowOnProductDetail>
</Items>
<MasterPLU>sample string 1</MasterPLU>
</clsTillMenuFollowOnProduct>
</ArrayOfclsTillMenuFollowOnProduct>