POST api/TillMenu/ProductSearch

Returns a collection of products based on the supplied search criteria. This can be used when the Products action has not yet finished running - perhaps as a background task.

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.ProductSearchArguments

Name	Type	Additional information
ProductDescription	string	None.
PLU	string	None.
GroupDescription	string	None.
DepartmentDescription	string	None.
SupplierName	string	None.
StyleReference	string	None.
TradeCustomerName	string	None.
SourceCodeID	integer	None.
CustomerID	string	None.
MaxRecords	integer	Required Range: inclusive between 1 and 1000

Request Formats

application/json, text/json

Sample:

{
  "ProductDescription": "sample string 1",
  "PLU": "sample string 2",
  "GroupDescription": "sample string 3",
  "DepartmentDescription": "sample string 4",
  "SupplierName": "sample string 5",
  "StyleReference": "sample string 6",
  "TradeCustomerName": "sample string 7",
  "SourceCodeID": 1,
  "CustomerID": "sample string 8",
  "MaxRecords": 9
}

application/xml, text/xml

Sample:

<ProductSearchArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CustomerID>sample string 8</CustomerID>
  <DepartmentDescription>sample string 4</DepartmentDescription>
  <GroupDescription>sample string 3</GroupDescription>
  <MaxRecords>9</MaxRecords>
  <PLU>sample string 2</PLU>
  <ProductDescription>sample string 1</ProductDescription>
  <SourceCodeID>1</SourceCodeID>
  <StyleReference>sample string 6</StyleReference>
  <SupplierName>sample string 5</SupplierName>
  <TradeCustomerName>sample string 7</TradeCustomerName>
</ProductSearchArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsTillMenuProduct

Name	Type	Additional information
SKU	string	Required
AdditionalSKUs	Collection of string	None.
Group	string	None.
Department	string	None.
Description	string	None.
Supplier	string	None.
StyleReference	string	None.
TradeCustomerID	string	None.
TradeCustomerName	string	None.
IsOpenPriced	boolean	Required
IsOpenDescription	boolean	Required
ColourName	string	None.
Size	string	None.
Prices	Collection of EskimoClassLibraries.clsPrice	None.
TaxID	integer	None.
StockLevel	integer	None.
StockLevel1	integer	None.
StockLevel2	integer	None.
StockLevel3	integer	None.
StockWarnLevel	integer	None.
BuyTodayPrice	decimal number	None.
NoDiscountAllowed	boolean	None.
WeightValue	decimal number	None.
WeightMeasureUnit	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SKU": "sample string 1",
    "AdditionalSKUs": [
      "sample string 1",
      "sample string 2"
    ],
    "Group": "sample string 2",
    "Department": "sample string 3",
    "Description": "sample string 4",
    "Supplier": "sample string 5",
    "StyleReference": "sample string 6",
    "TradeCustomerID": "sample string 7",
    "TradeCustomerName": "sample string 8",
    "IsOpenPriced": true,
    "IsOpenDescription": true,
    "ColourName": "sample string 11",
    "Size": "sample string 12",
    "Prices": [
      {
        "PriceLevel": 1,
        "Price": 2.0
      },
      {
        "PriceLevel": 1,
        "Price": 2.0
      }
    ],
    "TaxID": 13,
    "StockLevel": 14,
    "StockLevel1": 15,
    "StockLevel2": 16,
    "StockLevel3": 17,
    "StockWarnLevel": 1,
    "BuyTodayPrice": 1.0,
    "NoDiscountAllowed": true,
    "WeightValue": 1.0,
    "WeightMeasureUnit": 1
  },
  {
    "SKU": "sample string 1",
    "AdditionalSKUs": [
      "sample string 1",
      "sample string 2"
    ],
    "Group": "sample string 2",
    "Department": "sample string 3",
    "Description": "sample string 4",
    "Supplier": "sample string 5",
    "StyleReference": "sample string 6",
    "TradeCustomerID": "sample string 7",
    "TradeCustomerName": "sample string 8",
    "IsOpenPriced": true,
    "IsOpenDescription": true,
    "ColourName": "sample string 11",
    "Size": "sample string 12",
    "Prices": [
      {
        "PriceLevel": 1,
        "Price": 2.0
      },
      {
        "PriceLevel": 1,
        "Price": 2.0
      }
    ],
    "TaxID": 13,
    "StockLevel": 14,
    "StockLevel1": 15,
    "StockLevel2": 16,
    "StockLevel3": 17,
    "StockWarnLevel": 1,
    "BuyTodayPrice": 1.0,
    "NoDiscountAllowed": true,
    "WeightValue": 1.0,
    "WeightMeasureUnit": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsTillMenuProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsTillMenuProduct>
    <AdditionalSKUs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdditionalSKUs>
    <BuyTodayPrice>1</BuyTodayPrice>
    <ColourName>sample string 11</ColourName>
    <Department>sample string 3</Department>
    <Description>sample string 4</Description>
    <Group>sample string 2</Group>
    <IsOpenDescription>true</IsOpenDescription>
    <IsOpenPriced>true</IsOpenPriced>
    <NoDiscountAllowed>true</NoDiscountAllowed>
    <Prices>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
    </Prices>
    <SKU>sample string 1</SKU>
    <Size>sample string 12</Size>
    <StockLevel>14</StockLevel>
    <StockLevel1>15</StockLevel1>
    <StockLevel2>16</StockLevel2>
    <StockLevel3>17</StockLevel3>
    <StockWarnLevel>1</StockWarnLevel>
    <StyleReference>sample string 6</StyleReference>
    <Supplier>sample string 5</Supplier>
    <TaxID>13</TaxID>
    <TradeCustomerID>sample string 7</TradeCustomerID>
    <TradeCustomerName>sample string 8</TradeCustomerName>
    <WeightMeasureUnit>1</WeightMeasureUnit>
    <WeightValue>1</WeightValue>
  </clsTillMenuProduct>
  <clsTillMenuProduct>
    <AdditionalSKUs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdditionalSKUs>
    <BuyTodayPrice>1</BuyTodayPrice>
    <ColourName>sample string 11</ColourName>
    <Department>sample string 3</Department>
    <Description>sample string 4</Description>
    <Group>sample string 2</Group>
    <IsOpenDescription>true</IsOpenDescription>
    <IsOpenPriced>true</IsOpenPriced>
    <NoDiscountAllowed>true</NoDiscountAllowed>
    <Prices>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
    </Prices>
    <SKU>sample string 1</SKU>
    <Size>sample string 12</Size>
    <StockLevel>14</StockLevel>
    <StockLevel1>15</StockLevel1>
    <StockLevel2>16</StockLevel2>
    <StockLevel3>17</StockLevel3>
    <StockWarnLevel>1</StockWarnLevel>
    <StyleReference>sample string 6</StyleReference>
    <Supplier>sample string 5</Supplier>
    <TaxID>13</TaxID>
    <TradeCustomerID>sample string 7</TradeCustomerID>
    <TradeCustomerName>sample string 8</TradeCustomerName>
    <WeightMeasureUnit>1</WeightMeasureUnit>
    <WeightValue>1</WeightValue>
  </clsTillMenuProduct>
</ArrayOfclsTillMenuProduct>