POST api/TillMenu/ProductsDump

Iterates all the products in the database. Used mainly for exporting all information to till for offline use.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DateFrom		date	None.
PageSize	Optional. If paging information is sent in the request, it will be adhered to. If omitted, the entire result set will be returned.	integer	None.
PageRequired		integer	None.
TillNumber		integer	None.
StoreNumber		string	String length: inclusive between 3 and 3
PLU		string	None.

Request Formats

application/json, text/json

Sample:

{
  "DateFrom": "2024-05-03T08:24:05.3409658+01:00",
  "PageSize": 1,
  "PageRequired": 1,
  "TillNumber": 1,
  "StoreNumber": "sample string 2",
  "PLU": "sample string 3"
}

application/xml, text/xml

Sample:

<ProductDumpArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <DateFrom>2024-05-03T08:24:05.3409658+01:00</DateFrom>
  <PLU>sample string 3</PLU>
  <PageRequired>1</PageRequired>
  <PageSize>1</PageSize>
  <StoreNumber>sample string 2</StoreNumber>
  <TillNumber>1</TillNumber>
</ProductDumpArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsTillMenuProductExt

Name	Description	Type	Additional information
PLU		string	Required
SecondaryPLU		string	None.
Department		string	None.
Description		string	None.
Prices		Collection of EskimoClassLibraries.clsPrice	None.
Supplier		string	None.
StyleReference		string	None.
TradeCustomerName		string	None.
StockLevel		integer	None.
TaxID	See api/TaxCodes/All	integer	Required
IsOpenPriced		boolean	Required
ColourName		string	None.
ColourValue		string	None.
Size		string	None.
StockWarnLevel		integer	None.
Weight		integer	None.
NoDiscountAllowed		boolean	None.
AdditionalPLUs		Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PLU": "sample string 1",
    "SecondaryPLU": "sample string 2",
    "Department": "sample string 3",
    "Description": "sample string 4",
    "Prices": [
      {
        "PriceLevel": 1,
        "Price": 2.0
      },
      {
        "PriceLevel": 1,
        "Price": 2.0
      }
    ],
    "Supplier": "sample string 5",
    "StyleReference": "sample string 6",
    "TradeCustomerName": "sample string 7",
    "StockLevel": 8,
    "TaxID": 9,
    "IsOpenPriced": true,
    "ColourName": "sample string 11",
    "ColourValue": "sample string 12",
    "Size": "sample string 13",
    "StockWarnLevel": 1,
    "Weight": 14,
    "NoDiscountAllowed": true,
    "AdditionalPLUs": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "PLU": "sample string 1",
    "SecondaryPLU": "sample string 2",
    "Department": "sample string 3",
    "Description": "sample string 4",
    "Prices": [
      {
        "PriceLevel": 1,
        "Price": 2.0
      },
      {
        "PriceLevel": 1,
        "Price": 2.0
      }
    ],
    "Supplier": "sample string 5",
    "StyleReference": "sample string 6",
    "TradeCustomerName": "sample string 7",
    "StockLevel": 8,
    "TaxID": 9,
    "IsOpenPriced": true,
    "ColourName": "sample string 11",
    "ColourValue": "sample string 12",
    "Size": "sample string 13",
    "StockWarnLevel": 1,
    "Weight": 14,
    "NoDiscountAllowed": true,
    "AdditionalPLUs": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsTillMenuProductExt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsTillMenuProductExt>
    <AdditionalPLUs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdditionalPLUs>
    <ColourName>sample string 11</ColourName>
    <ColourValue>sample string 12</ColourValue>
    <Department>sample string 3</Department>
    <Description>sample string 4</Description>
    <IsOpenPriced>true</IsOpenPriced>
    <NoDiscountAllowed>true</NoDiscountAllowed>
    <PLU>sample string 1</PLU>
    <Prices>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
    </Prices>
    <SecondaryPLU>sample string 2</SecondaryPLU>
    <Size>sample string 13</Size>
    <StockLevel>8</StockLevel>
    <StockWarnLevel>1</StockWarnLevel>
    <StyleReference>sample string 6</StyleReference>
    <Supplier>sample string 5</Supplier>
    <TaxID>9</TaxID>
    <TradeCustomerName>sample string 7</TradeCustomerName>
    <Weight>14</Weight>
  </clsTillMenuProductExt>
  <clsTillMenuProductExt>
    <AdditionalPLUs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdditionalPLUs>
    <ColourName>sample string 11</ColourName>
    <ColourValue>sample string 12</ColourValue>
    <Department>sample string 3</Department>
    <Description>sample string 4</Description>
    <IsOpenPriced>true</IsOpenPriced>
    <NoDiscountAllowed>true</NoDiscountAllowed>
    <PLU>sample string 1</PLU>
    <Prices>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
      <clsPrice>
        <Price>2</Price>
        <PriceLevel>1</PriceLevel>
      </clsPrice>
    </Prices>
    <SecondaryPLU>sample string 2</SecondaryPLU>
    <Size>sample string 13</Size>
    <StockLevel>8</StockLevel>
    <StockWarnLevel>1</StockWarnLevel>
    <StyleReference>sample string 6</StyleReference>
    <Supplier>sample string 5</Supplier>
    <TaxID>9</TaxID>
    <TradeCustomerName>sample string 7</TradeCustomerName>
    <Weight>14</Weight>
  </clsTillMenuProductExt>
</ArrayOfclsTillMenuProductExt>