POST api/TillMenu/ProductInformation

Returns information about the till unit being used. A 405 (Method Not Allowed) will be received if the user has not yet been setup for a specific till. A 404 (Not Found) will be received if the user has been assigned to a till, but incorrectly.

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.ProductInformationArgs
NameDescriptionTypeAdditional information
PLU

string

Required
StoreNumber

string

Required

String length: inclusive between 3 and 3

Request Formats

application/json, text/json

Sample: 
{
  "PLU": "sample string 1",
  "StoreNumber": "sample string 2"
}

application/xml, text/xml

Sample: 
<ProductInformationArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <PLU>sample string 1</PLU>
  <StoreNumber>sample string 2</StoreNumber>
</ProductInformationArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EskimoClassLibraries.clsTillMenuProductInfo
NameDescriptionTypeAdditional information
PLU

string

None.
CompanyStock

EskimoClassLibraries.clsCompanyStock

None.
OnPurchaseOrder

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "PLU": "sample string 1",
  "CompanyStock": {
    "StockBreakdown": [
      {
        "ShopID": "sample string 1",
        "ShopName": "sample string 2",
        "IsWarehouse": true,
        "StockLevel": 4
      },
      {
        "ShopID": "sample string 1",
        "ShopName": "sample string 2",
        "IsWarehouse": true,
        "StockLevel": 4
      }
    ],
    "ExpectedDeliveryBreakdown": [
      {
        "Qty": 1,
        "ExpDate": "2025-01-18T04:03:31.8241975+00:00"
      },
      {
        "Qty": 1,
        "ExpDate": "2025-01-18T04:03:31.8241975+00:00"
      }
    ],
    "CompanyStock": 8,
    "ExpectingQty": 2
  },
  "OnPurchaseOrder": 2
}

application/xml, text/xml

Sample: 
<clsTillMenuProductInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CompanyStock>
    <ExpectedDeliveryBreakdown>
      <clsExpectedDelivery>
        <ExpDate>2025-01-18T04:03:31.8241975+00:00</ExpDate>
        <Qty>1</Qty>
      </clsExpectedDelivery>
      <clsExpectedDelivery>
        <ExpDate>2025-01-18T04:03:31.8241975+00:00</ExpDate>
        <Qty>1</Qty>
      </clsExpectedDelivery>
    </ExpectedDeliveryBreakdown>
    <StockBreakdown>
      <clsShopStock>
        <IsWarehouse>true</IsWarehouse>
        <ShopID>sample string 1</ShopID>
        <ShopName>sample string 2</ShopName>
        <StockLevel>4</StockLevel>
      </clsShopStock>
      <clsShopStock>
        <IsWarehouse>true</IsWarehouse>
        <ShopID>sample string 1</ShopID>
        <ShopName>sample string 2</ShopName>
        <StockLevel>4</StockLevel>
      </clsShopStock>
    </StockBreakdown>
  </CompanyStock>
  <OnPurchaseOrder>2</OnPurchaseOrder>
  <PLU>sample string 1</PLU>
</clsTillMenuProductInfo>