POST GetProductDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProductID	integer	None.
ProductGroupID	integer	None.
vProductCode	string	None.
vProductEnglishName	string	None.
vProductChineseName	string	None.
Price	decimal number	None.
CustomisePrice	boolean	None.
Description	string	None.
vSpicy	string	None.
vVegetarian	string	None.
vOrigin	string	None.
vCourse	string	None.
vMenuDescription	string	None.
DateCreated	date	None.
DelInd	boolean	None.
Forecolour	string	None.
Backcolour	string	None.
FoodRefil	boolean	None.
SortOrder	integer	None.
IsTakeaway	boolean	None.
LastModified	date	None.
FridgeQty	integer	None.
ProductTypeID	integer	None.
IsFridgeItem	boolean	None.
ReplenishedOn	date	None.
IncludeInOutofDateAlert	boolean	None.
ShelfLifeInHours	decimal number	None.
vAllergens	string	None.
ImageName	string	None.
bVegetarain	boolean	None.
bSpicy	integer	None.
bGlutenFree	boolean	None.
RewardPoints	integer	None.
RedemptionPoints	integer	None.
ProductQty	integer	None.
RewardValidUntil	date	None.
RedeemValidUntil	date	None.
RedeemValidDays	integer	None.
RewardValidityPeriod	string	None.
RedeemValidityPeriod	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductID": 1,
  "ProductGroupID": 1,
  "vProductCode": "sample string 2",
  "vProductEnglishName": "sample string 3",
  "vProductChineseName": "sample string 4",
  "Price": 1.1,
  "CustomisePrice": true,
  "Description": "sample string 6",
  "vSpicy": "sample string 7",
  "vVegetarian": "sample string 8",
  "vOrigin": "sample string 9",
  "vCourse": "sample string 10",
  "vMenuDescription": "sample string 11",
  "DateCreated": "2025-10-25T12:08:57.519459+01:00",
  "DelInd": true,
  "Forecolour": "sample string 13",
  "Backcolour": "sample string 14",
  "FoodRefil": true,
  "SortOrder": 16,
  "IsTakeaway": true,
  "LastModified": "2025-10-25T12:08:57.519459+01:00",
  "FridgeQty": 1,
  "ProductTypeID": 1,
  "IsFridgeItem": true,
  "ReplenishedOn": "2025-10-25T12:08:57.519459+01:00",
  "IncludeInOutofDateAlert": true,
  "ShelfLifeInHours": 1.1,
  "vAllergens": "sample string 20",
  "ImageName": "sample string 21",
  "bVegetarain": true,
  "bSpicy": 1,
  "bGlutenFree": true,
  "RewardPoints": 1,
  "RedemptionPoints": 1,
  "ProductQty": 22,
  "RewardValidUntil": "2025-10-25T12:08:57.5199551+01:00",
  "RedeemValidUntil": "2025-10-25T12:08:57.5204511+01:00",
  "RedeemValidDays": 25,
  "RewardValidityPeriod": "25/10/2025 12:08",
  "RedeemValidityPeriod": "19/11/2025 12:08"
}

application/xml, text/xml

Sample:

<ProductDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TCB.Entity.Dtos">
  <Backcolour>sample string 14</Backcolour>
  <CustomisePrice>true</CustomisePrice>
  <DateCreated>2025-10-25T12:08:57.519459+01:00</DateCreated>
  <DelInd>true</DelInd>
  <Description>sample string 6</Description>
  <FoodRefil>true</FoodRefil>
  <Forecolour>sample string 13</Forecolour>
  <FridgeQty>1</FridgeQty>
  <ImageName>sample string 21</ImageName>
  <IncludeInOutofDateAlert>true</IncludeInOutofDateAlert>
  <IsFridgeItem>true</IsFridgeItem>
  <IsTakeaway>true</IsTakeaway>
  <LastModified>2025-10-25T12:08:57.519459+01:00</LastModified>
  <Price>1.1</Price>
  <ProductGroupID>1</ProductGroupID>
  <ProductID>1</ProductID>
  <ProductQty>22</ProductQty>
  <ProductTypeID>1</ProductTypeID>
  <RedeemValidDays>25</RedeemValidDays>
  <RedeemValidUntil>2025-10-25T12:08:57.5204511+01:00</RedeemValidUntil>
  <RedeemValidityPeriod>19/11/2025 12:08</RedeemValidityPeriod>
  <RedemptionPoints>1</RedemptionPoints>
  <ReplenishedOn>2025-10-25T12:08:57.519459+01:00</ReplenishedOn>
  <RewardPoints>1</RewardPoints>
  <RewardValidUntil>2025-10-25T12:08:57.5199551+01:00</RewardValidUntil>
  <RewardValidityPeriod>25/10/2025 12:08</RewardValidityPeriod>
  <ShelfLifeInHours>1.1</ShelfLifeInHours>
  <SortOrder>16</SortOrder>
  <bGlutenFree>true</bGlutenFree>
  <bSpicy>1</bSpicy>
  <bVegetarain>true</bVegetarain>
  <vAllergens>sample string 20</vAllergens>
  <vCourse>sample string 10</vCourse>
  <vMenuDescription>sample string 11</vMenuDescription>
  <vOrigin>sample string 9</vOrigin>
  <vProductChineseName>sample string 4</vProductChineseName>
  <vProductCode>sample string 2</vProductCode>
  <vProductEnglishName>sample string 3</vProductEnglishName>
  <vSpicy>sample string 7</vSpicy>
  <vVegetarian>sample string 8</vVegetarian>
</ProductDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ProductDto'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.