GET api/SalesItem/{id}

Returns detailed sales item information

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Articlenumber	integer	Required

Body Parameters

None.

Response Information

Resource Description

One Sales Item Object

SalesItem

Name	Description	Type	Additional information
PLU	Number of the Sales item numeric [1-999999999]	integer	None.
Code	Code of the Sales item string[50]	string	None.
Descriptions	List Of Descriptions	Collection of Description	None.
GroupCode	Group Code Kost string[50] KOST:WGVerkauf.EigenCode	string	None.
MainGroupCode	Main group Code Kost string[50] KOST:Warenobergruppen.Code	string	None.
Categories	Additional Infos (1..20) KOST: VArtikelRezeptur.ZusatzinfoXX	Collection of Category	None.
Nutritions	List of Nutritions	Collection of Nutrition	None.
Allergens	List of Allergens	Collection of Allergen	None.
Barcodes	Barcodes of the Sales item	Collection of string	None.
Pictures	Source where the picture can be found KOST:VArtikelFoto	Collection of string	None.
RecipeIngredients	First level Recipe Ingredients	Collection of RecipeIngredient	None.
FoodCost	cost of goods [7,2]	decimal number	None.
EdibleWeight	Verwertbares Gewicht	decimal number	None.
IsCommissionItem	Commission Item KOST:VArtikel.MatPosIsCredit	boolean	None.
IsManualPrice	Manual Price Can Be Entered KOST:VArtikelRezeptur.MatPosIsFreePrice	boolean	None.
IsControlItem	Control Item KOST:VArtikelRezeptur.MatPosIsControl	boolean	None.
TouchPrio	Sorting Order KOST:VArtikelRezeptur.MatPosIsTouchPrio	integer	None.
IsStockItem	Fassungsartikel KOST:VArtikelRezeptur.Verbrauchsartikel	boolean	None.
IsMainDishItem	Main Dish Item KOST:VArtikelRezeptur.CCIsMainDish	boolean	None.
IsSideDishItem	Side Dish Item KOST:VArtikelRezeptur.CCIsSideDish	boolean	None.
IgnoreDiscount	Ignore Discount KOST:VArtikelRezeptur.MatPosIsNoDisc	boolean	None.
IsManualText	Manual Price KOST:VArtikelRezeptur.MatPosIsFreeText	boolean	None.
IsNote	Note, Hint KOST:VArtikelRezeptur.MatPosIsHint	boolean	None.
IsWeightItem	Weight Item KOST:VArtikelRezeptur.MatPosIsWeight	boolean	None.
Weight	Weight Value in Gramm KOST:VArtikelRezeptur.MatPosWeight	integer	None.
IsReturnable	Returnable Item KOST:VArtikelRezeptur.POSPfandartikel	boolean	None.
IsReturnableBon	Returnable Item Bon KOST:VArtikelRezeptur.POSPfandbon	boolean	None.
IsPortionable	Portionable Item KOST:VArtikelRezeptur.POSPortionierbar	boolean	None.
HasConstraints	Constraint Item (Zwangsartikel) KOST:VArtikelRezeptur.MatPosIsZwang	boolean	None.
Constraints		Collection of Constraint	None.
Assignments		Collection of Assignment	None.
VATs	List of VATs	Collection of VATofDiv	None.

Response Formats

application/json, text/json

Sample:

{
  "PLU": 1,
  "Code": "sample string 2",
  "Descriptions": [
    {
      "DescriptionType": 1,
      "LanguageCode": "sample string 2",
      "Description": "sample string 3"
    },
    {
      "DescriptionType": 1,
      "LanguageCode": "sample string 2",
      "Description": "sample string 3"
    }
  ],
  "GroupCode": "sample string 3",
  "MainGroupCode": "sample string 4",
  "Categories": [
    {
      "CategoryNumber": 1,
      "CategoryValue": true
    },
    {
      "CategoryNumber": 1,
      "CategoryValue": true
    }
  ],
  "Nutritions": [
    {
      "NutritionNumber": 1,
      "NutritionValue": 2.0,
      "NutritionDescription": "sample string 3"
    },
    {
      "NutritionNumber": 1,
      "NutritionValue": 2.0,
      "NutritionDescription": "sample string 3"
    }
  ],
  "Allergens": [
    {
      "AllergenCode": "sample string 1",
      "AllergenValue": 2
    },
    {
      "AllergenCode": "sample string 1",
      "AllergenValue": 2
    }
  ],
  "Barcodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Pictures": [
    "sample string 1",
    "sample string 2"
  ],
  "RecipeIngredients": null,
  "FoodCost": 5.0,
  "EdibleWeight": 6.0,
  "IsCommissionItem": true,
  "IsManualPrice": true,
  "IsControlItem": true,
  "TouchPrio": 10,
  "IsStockItem": true,
  "IsMainDishItem": true,
  "IsSideDishItem": true,
  "IgnoreDiscount": true,
  "IsManualText": true,
  "IsNote": true,
  "IsWeightItem": true,
  "Weight": 18,
  "IsReturnable": true,
  "IsReturnableBon": true,
  "IsPortionable": true,
  "HasConstraints": true,
  "Constraints": [
    {
      "Level": 1,
      "DeleteTriggerItem": true,
      "CanBeCanceled": true,
      "TakeCount": true,
      "PLUs": [
        1,
        2
      ]
    },
    {
      "Level": 1,
      "DeleteTriggerItem": true,
      "CanBeCanceled": true,
      "TakeCount": true,
      "PLUs": [
        1,
        2
      ]
    }
  ],
  "Assignments": [
    {
      "CostCenterCode": "sample string 1",
      "SalesDivisionCode": "sample string 2",
      "IsActive": true,
      "IsMenuPlan": true,
      "Prices": null,
      "TouchPrio": 5
    },
    {
      "CostCenterCode": "sample string 1",
      "SalesDivisionCode": "sample string 2",
      "IsActive": true,
      "IsMenuPlan": true,
      "Prices": null,
      "TouchPrio": 5
    }
  ],
  "VATs": [
    {
      "Name": "sample string 1",
      "SPCode": "sample string 2",
      "VAT1": 3.0,
      "VAT2": 4.0,
      "VAT3": 5.0,
      "VAT4": 6.0,
      "VAT5": 7.0,
      "VAT6": 8.0,
      "VAT7": 9.0,
      "VAT8": 10.0,
      "VAT9": 11.0,
      "VAT10": 12.0
    },
    {
      "Name": "sample string 1",
      "SPCode": "sample string 2",
      "VAT1": 3.0,
      "VAT2": 4.0,
      "VAT3": 5.0,
      "VAT4": 6.0,
      "VAT5": 7.0,
      "VAT6": 8.0,
      "VAT7": 9.0,
      "VAT8": 10.0,
      "VAT9": 11.0,
      "VAT10": 12.0
    }
  ]
}

application/xml, text/xml

Sample:

<SalesItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KOSTIFC">
  <Allergens>
    <SalesItem.Allergen>
      <AllergenCode>sample string 1</AllergenCode>
      <AllergenValue>2</AllergenValue>
    </SalesItem.Allergen>
    <SalesItem.Allergen>
      <AllergenCode>sample string 1</AllergenCode>
      <AllergenValue>2</AllergenValue>
    </SalesItem.Allergen>
  </Allergens>
  <Assignments>
    <SalesItem.Assignment>
      <CostCenterCode>sample string 1</CostCenterCode>
      <IsActive>true</IsActive>
      <IsMenuPlan>true</IsMenuPlan>
      <Prices i:nil="true" />
      <SalesDivisionCode>sample string 2</SalesDivisionCode>
      <TouchPrio>5</TouchPrio>
    </SalesItem.Assignment>
    <SalesItem.Assignment>
      <CostCenterCode>sample string 1</CostCenterCode>
      <IsActive>true</IsActive>
      <IsMenuPlan>true</IsMenuPlan>
      <Prices i:nil="true" />
      <SalesDivisionCode>sample string 2</SalesDivisionCode>
      <TouchPrio>5</TouchPrio>
    </SalesItem.Assignment>
  </Assignments>
  <Barcodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Barcodes>
  <Categories>
    <SalesItem.Category>
      <CategoryNumber>1</CategoryNumber>
      <CategoryValue>true</CategoryValue>
    </SalesItem.Category>
    <SalesItem.Category>
      <CategoryNumber>1</CategoryNumber>
      <CategoryValue>true</CategoryValue>
    </SalesItem.Category>
  </Categories>
  <Code>sample string 2</Code>
  <Constraints>
    <SalesItem.Constraint>
      <CanBeCanceled>true</CanBeCanceled>
      <DeleteTriggerItem>true</DeleteTriggerItem>
      <Level>1</Level>
      <PLUs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </PLUs>
      <TakeCount>true</TakeCount>
    </SalesItem.Constraint>
    <SalesItem.Constraint>
      <CanBeCanceled>true</CanBeCanceled>
      <DeleteTriggerItem>true</DeleteTriggerItem>
      <Level>1</Level>
      <PLUs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </PLUs>
      <TakeCount>true</TakeCount>
    </SalesItem.Constraint>
  </Constraints>
  <Descriptions>
    <SalesItem.Description>
      <Description>sample string 3</Description>
      <DescriptionType>1</DescriptionType>
      <LanguageCode>sample string 2</LanguageCode>
    </SalesItem.Description>
    <SalesItem.Description>
      <Description>sample string 3</Description>
      <DescriptionType>1</DescriptionType>
      <LanguageCode>sample string 2</LanguageCode>
    </SalesItem.Description>
  </Descriptions>
  <EdibleWeight>6</EdibleWeight>
  <FoodCost>5</FoodCost>
  <GroupCode>sample string 3</GroupCode>
  <HasConstraints>true</HasConstraints>
  <IgnoreDiscount>true</IgnoreDiscount>
  <IsCommissionItem>true</IsCommissionItem>
  <IsControlItem>true</IsControlItem>
  <IsMainDishItem>true</IsMainDishItem>
  <IsManualPrice>true</IsManualPrice>
  <IsManualText>true</IsManualText>
  <IsNote>true</IsNote>
  <IsPortionable>true</IsPortionable>
  <IsReturnable>true</IsReturnable>
  <IsReturnableBon>true</IsReturnableBon>
  <IsSideDishItem>true</IsSideDishItem>
  <IsStockItem>true</IsStockItem>
  <IsWeightItem>true</IsWeightItem>
  <MainGroupCode>sample string 4</MainGroupCode>
  <Nutritions>
    <SalesItem.Nutrition>
      <NutritionDescription>sample string 3</NutritionDescription>
      <NutritionNumber>1</NutritionNumber>
      <NutritionValue>2</NutritionValue>
    </SalesItem.Nutrition>
    <SalesItem.Nutrition>
      <NutritionDescription>sample string 3</NutritionDescription>
      <NutritionNumber>1</NutritionNumber>
      <NutritionValue>2</NutritionValue>
    </SalesItem.Nutrition>
  </Nutritions>
  <PLU>1</PLU>
  <Pictures xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Pictures>
  <RecipeIngredients i:nil="true" />
  <TouchPrio>10</TouchPrio>
  <VATs>
    <SalesItem.VATofDiv>
      <Name>sample string 1</Name>
      <SPCode>sample string 2</SPCode>
      <VAT1>3</VAT1>
      <VAT10>12</VAT10>
      <VAT2>4</VAT2>
      <VAT3>5</VAT3>
      <VAT4>6</VAT4>
      <VAT5>7</VAT5>
      <VAT6>8</VAT6>
      <VAT7>9</VAT7>
      <VAT8>10</VAT8>
      <VAT9>11</VAT9>
    </SalesItem.VATofDiv>
    <SalesItem.VATofDiv>
      <Name>sample string 1</Name>
      <SPCode>sample string 2</SPCode>
      <VAT1>3</VAT1>
      <VAT10>12</VAT10>
      <VAT2>4</VAT2>
      <VAT3>5</VAT3>
      <VAT4>6</VAT4>
      <VAT5>7</VAT5>
      <VAT6>8</VAT6>
      <VAT7>9</VAT7>
      <VAT8>10</VAT8>
      <VAT9>11</VAT9>
    </SalesItem.VATofDiv>
  </VATs>
  <Weight>18</Weight>
</SalesItem>