GET api/Product/GetById/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Product| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
Max length: 200 |
|
| SKU | string |
Max length: 200 |
|
| BarCode | string |
Max length: 100 |
|
| PLU | string |
Max length: 100 |
|
| GroupId | globally unique identifier |
None. |
|
| SupplierId | globally unique identifier |
None. |
|
| SupplierSKU | string |
Max length: 100 |
|
| BrandId | integer |
None. |
|
| Description | string |
Max length: 150 |
|
| LongDescription | string |
None. |
|
| BongTitle | string |
Max length: 100 |
|
| TextColor | string |
Max length: 10 |
|
| ColorCode | string |
Max length: 10 |
|
| IconId | integer |
None. |
|
| ShowItemButton | boolean |
None. |
|
| ShowGroupItem | boolean |
None. |
|
| Price | decimal number |
None. |
|
| PurchasePrice | decimal number |
None. |
|
| Tax | decimal number |
None. |
|
| Unit | ProductUnit |
None. |
|
| AskPrice | boolean |
None. |
|
| AskWeight | boolean |
None. |
|
| PriceLock | boolean |
None. |
|
| PrinterId | integer |
None. |
|
| PlaceHolder | boolean |
None. |
|
| AskVolume | boolean |
None. |
|
| NeedIngredient | boolean |
None. |
|
| Bong | boolean |
None. |
|
| Sticky | integer |
None. |
|
| Seamless | boolean |
None. |
|
| AccountingId | integer |
None. |
|
| ReceiptMethod | ReceiptMethod |
None. |
|
| ItemType | ItemType |
None. |
|
| DiscountAllowed | boolean |
None. |
|
| PreparationTime | PrepareTime |
None. |
|
| PrepMinutes | integer |
None. |
|
| IngredientPopup | boolean |
None. |
|
| DefaultCartQty | decimal number |
None. |
|
| SortOrder | integer |
None. |
|
| Active | boolean |
None. |
|
| Deleted | boolean |
None. |
|
| Weight | decimal number |
None. |
|
| Availability | boolean |
None. |
|
| ServeType | byte |
None. |
|
| Synced | boolean |
None. |
|
| DemandIdControl | boolean |
None. |
|
| Discontinued | boolean |
None. |
|
| AskPLU | boolean |
None. |
|
| NoticeStockLevel | decimal number |
None. |
|
| DefaultUnit | ProductUnit |
None. |
|
| ManageStock | integer |
None. |
|
| PriceRek | decimal number |
None. |
|
| CommentsRequired | boolean |
None. |
|
| TicketQty | integer |
None. |
|
| MinCartQty | decimal number |
None. |
|
| MinQtyAlert | decimal number |
None. |
|
| ComissionPercent | decimal number |
None. |
|
| PantPrice | decimal number |
None. |
|
| TrackAmount | boolean |
None. |
|
| SaleUnitSuffix | string |
None. |
|
| QtyPerSaleUnit | decimal number |
None. |
|
| AutoClose | boolean |
None. |
|
| ButtonTitle | string |
Max length: 100 |
|
| SpecialSalesPrice | decimal number |
None. |
|
| SpecialSalesPriceValidFrom | date |
None. |
|
| SpecialSalesPriceValidTo | date |
None. |
|
| Draft | boolean |
None. |
|
| VatChangeBehavior | VatChangeBehavior |
None. |
|
| ItemTypeUUID | globally unique identifier |
None. |
|
| ItemGroupUUID | globally unique identifier |
None. |
|
| ItemAttributeSetUUID | globally unique identifier |
None. |
|
| BrandUUID | globally unique identifier |
None. |
|
| TicketTemplateId | integer |
None. |
|
| OrderOptionType | OrderOptionType |
None. |
|
| BestBeforeDays | integer |
None. |
|
| Created | date |
None. |
|
| Updated | date |
None. |
|
| UpdatedBy | globally unique identifier |
None. |
|
| CategoryId | integer |
None. |
|
| Campaign | CampaignMaster |
None. |
|
| ItemsTags | Collection of ItemTag |
None. |
|
| ItemCampaign | ItemCampaign |
None. |
|
| HasPricePolicy | boolean |
None. |
|
| ItemCategory | Collection of ItemCategory |
None. |
|
| ItemIdex | integer |
None. |
|
| PolicyGroupId | integer |
None. |
|
| HasCampaign | boolean |
None. |
|
| Products | Collection of Product |
None. |
|
| ColorName | string |
None. |
|
| Type | integer |
None. |
|
| ImagePath | string |
None. |
|
| ImageVisibility | boolean |
None. |
|
| ifExists | string |
None. |
|
| ProductPrices | Collection of ProductPrice |
None. |
|
| Ingredients | Collection of Product |
None. |
|
| Variants | Collection of ItemConfiguration |
None. |
|
| ItemOption | Collection of ItemOption |
None. |
|
| ShowOnReceipt | boolean |
None. |
|
| QuickAdd | boolean |
None. |
|
| HasIngredients | boolean |
None. |
|
| HasVariants | boolean |
None. |
|
| HasOptions | boolean |
None. |
|
| CategoryItemGroups | Collection of CategoryItemGroup |
None. |
|
| ItemPricePolicies | Collection of Item_PricePolicy |
None. |
|
| PriceGroupPolicies | Collection of PriceGroupPolicy |
None. |
|
| Photo | Collection of byte |
None. |
|
| GroupPrice | decimal number |
None. |
|
| ExternalId | string |
None. |
|
| IngredientQty | decimal number |
None. |
|
| StockQty | decimal number |
None. |
|
| Attributes | string |
None. |
|
| LocalStockNull | boolean |
None. |
|
| StockInitialCount | decimal number |
None. |
|
| Selected | boolean |
None. |
|
| ShowWarhouseStock | boolean |
None. |
|
| ShowStockQty | boolean |
None. |
|
| HideStockQty | boolean |
None. |
|
| IsRUT | boolean |
None. |
|
| NotSelected | boolean |
None. |
|
| IsInActive | boolean |
None. |
|
| CreatedBy | string |
None. |
|
| TerminalId | globally unique identifier |
None. |
|
| CategoryName | string |
None. |
|
| ShowCategoryName | boolean |
None. |
|
| DiscountedPrice | decimal number |
None. |
|
| Qty | decimal number |
None. |
|
| ConfigurationId | integer |
None. |
|
| ItemOptionId | globally unique identifier |
None. |
|
| PriceAdd | decimal number |
None. |
|
| PriceRemove | decimal number |
None. |
|
| FreeQty | decimal number |
None. |
|
| MinQty | decimal number |
None. |
|
| MaxQty | decimal number |
None. |
|
| FirstItemSelected | boolean |
None. |
|
| OptionForOrderType | OptionForOrderType |
None. |
|
| PLUNumeric | integer |
None. |
|
| ScalePrice | decimal number |
None. |
|
| Files | Collection of FileData |
None. |
|
| HasFile | boolean |
None. |
|
| ItemTypeText | string |
None. |
|
| ItemUnitText | string |
None. |
|
| LanguageTexts | Collection of ItemLanguageText |
None. |
|
| ItemAdditionalIdentifications | Collection of ItemAdditionalIdentification |
None. |
|
| IsManageStock | boolean |
None. |
|
| PriceExlTax | decimal number |
None. |
|
| IndexId | integer |
None. |
|
| IsSelected | boolean |
None. |
|
| HideQuantityUnit | boolean |
None. |
Response Formats
application/json, text/json
{
"Id": "a2d48f4a-8573-4e09-83ea-9cebd0f5c8b6",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "226b9c88-f4ad-42be-ac9a-8764bc99d916",
"SupplierId": "9992a5a9-2c98-4697-8b14-6eddea0d6e8f",
"SupplierSKU": "sample string 7",
"BrandId": 8,
"Description": "sample string 9",
"LongDescription": "sample string 10",
"BongTitle": "sample string 11",
"TextColor": "sample string 12",
"ColorCode": "sample string 13",
"IconId": 14,
"ShowItemButton": true,
"ShowGroupItem": true,
"Price": 17.0,
"PurchasePrice": 18.0,
"Tax": 19.0,
"Unit": 0,
"AskPrice": true,
"AskWeight": true,
"PriceLock": true,
"PrinterId": 23,
"PlaceHolder": true,
"AskVolume": true,
"NeedIngredient": true,
"Bong": true,
"Sticky": 28,
"Seamless": true,
"AccountingId": 30,
"ReceiptMethod": 0,
"ItemType": 0,
"DiscountAllowed": true,
"PreparationTime": 0,
"PrepMinutes": 1,
"IngredientPopup": true,
"DefaultCartQty": 33.0,
"SortOrder": 34,
"Active": true,
"Deleted": true,
"Weight": 37.0,
"Availability": true,
"ServeType": 64,
"Synced": true,
"DemandIdControl": true,
"Discontinued": true,
"AskPLU": true,
"NoticeStockLevel": 44.0,
"DefaultUnit": 0,
"ManageStock": 45,
"PriceRek": 46.0,
"CommentsRequired": true,
"TicketQty": 48,
"MinCartQty": 49.0,
"MinQtyAlert": 50.0,
"ComissionPercent": 51.0,
"PantPrice": 52.0,
"TrackAmount": true,
"SaleUnitSuffix": "sample string 54",
"QtyPerSaleUnit": 55.0,
"AutoClose": true,
"ButtonTitle": "sample string 57",
"SpecialSalesPrice": 1.0,
"SpecialSalesPriceValidFrom": "2026-11-04T13:38:34.3710899+01:00",
"SpecialSalesPriceValidTo": "2026-11-04T13:38:34.3710899+01:00",
"Draft": true,
"VatChangeBehavior": 0,
"ItemTypeUUID": "c5d2db67-00a2-4f20-b561-ca0ece4d7642",
"ItemGroupUUID": "eba6e300-d039-4462-b272-76b4f24637b4",
"ItemAttributeSetUUID": "089afbf8-3c5d-4f26-9ce9-d681f2ef317a",
"BrandUUID": "b8e87655-e7bf-458d-acb6-f538790e78f7",
"TicketTemplateId": 1,
"OrderOptionType": 0,
"BestBeforeDays": 1,
"Created": "2026-11-04T13:38:34.3710899+01:00",
"Updated": "2026-11-04T13:38:34.3710899+01:00",
"UpdatedBy": "72f163fe-08ab-4d8c-8456-2a69577137ae",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "049b8143-ded6-4e42-baba-c6fd6522efd7",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-11-04T13:38:34.3710899+01:00",
"EndDate": "2026-11-04T13:38:34.3710899+01:00",
"Deleted": true,
"Updated": "2026-11-04T13:38:34.3710899+01:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "25600609-4f0f-4f2c-a6bf-a0f3ddfd598c",
"CampaignId": "8242a28a-23d8-45f7-83a6-d706e948948d",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-11-04T13:38:34.3710899+01:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "cbcc059e-7302-44f3-b2f0-dc8cf78ec7c4",
"TagId": "502c1f0f-c283-4bcd-a2fe-0dfd1cace0dc",
"ItemId": "f435e744-7024-43c1-8229-762d2cabae1a",
"Deleted": true,
"Synced": true,
"Updated": "2026-11-04T13:38:34.3710899+01:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "f5cc2988-2d10-40fb-bec7-67e98cb0e629",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-11-04T13:38:34.3710899+01:00",
"EndDate": "2026-11-04T13:38:34.3710899+01:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-11-04T13:38:34.3710899+01:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-11-04T13:38:34.3710899+01:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-11-04T13:38:34.3710899+01:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "9f3079a0-ee90-4c84-b73d-e02313839492",
"PriceListUUID": "53dd5662-27e4-4604-b63a-52fc479b452d",
"ItemGroupUUID": "736d3c0c-01b4-45a0-8c80-0110edaf847a",
"AgreementUUID": "368216b3-3397-4a3b-a9e9-92b2be3fb217",
"CustomerGroupUUID": "ca5d89ae-1623-461f-b96f-2cbca6c02371",
"CustomerUUID": "1a119f77-a8ce-49cc-9326-8d81d6f94ee8",
"ProjectUUID": "1572a3ec-ff0a-4c3c-865d-6f9187074309",
"CampaignUUID": "233e3a3e-c4ac-4b73-89fc-cfe17315e9a2",
"ItemUUID": "7568adb9-71b7-4977-80f3-c0cfbc367cb3",
"WildCardSKU": "sample string 4",
"MinQty": 1.0,
"MaxQty": 1.0,
"Price": 1.0,
"Percentage": 1.0,
"Type": "sample string 5",
"RegularPrice": true,
"PurchasePrice": 1.0,
"ValidFrom": "2026-11-04T13:38:34.3710899+01:00",
"ValidTo": "2026-11-04T13:38:34.3710899+01:00",
"CreatedAt": "2026-11-04T13:38:34.3710899+01:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-11-04T13:38:34.3710899+01:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-11-04T13:38:34.3710899+01:00",
"DeletedByUUID": "sample string 10",
"Synced": true,
"ItemName": "sample string 12",
"CampaignTitle": "sample string 13"
},
{
"$ref": "6"
}
]
},
"HasPricePolicy": true,
"ItemCategory": [
{
"$id": "7",
"Id": 1,
"ItemId": "337c8136-587c-446c-8853-2fc9c774bf5f",
"CategoryId": 3,
"SortOrder": 4,
"IsPrimary": true,
"CategoryBoostId": "sample string 6"
},
{
"$ref": "7"
}
],
"ItemIdex": 62,
"PolicyGroupId": 63,
"HasCampaign": true,
"Products": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"ColorName": "sample string 64",
"Type": 65,
"ImagePath": "sample string 66",
"ImageVisibility": true,
"ifExists": "sample string 68",
"ProductPrices": [
{
"$id": "8",
"Id": 1,
"ItemId": "78a574f5-6b2c-417d-88a0-1c99c720c3e6",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "5056d4d6-b922-445e-841d-6fd82ce6ec14",
"PriceMode": 0,
"Updated": "2026-11-04T13:38:34.3710899+01:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "15a10f1a-9159-41dc-99d8-ceca23a0f611",
"ItemId": "8714730c-b301-4645-ad11-44fe2be57087",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-11-04T13:38:34.3710899+01:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "d5013e5d-926e-477c-88a1-e76393ab7bba",
"ItemOptionGroupId": "d29a783e-db6b-41bd-8e20-a8c0f2b60379",
"ItemId": "3d0fee16-adf6-42d5-a99a-844400097e37",
"CategoryId": 4,
"Active": true,
"Updated": "2026-11-04T13:38:34.3710899+01:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "c52793eb-6a3f-4256-b2ed-22fa2d7a92d3",
"CategoryId": 2,
"GroupId": "439c5f05-bfbd-45ba-8ffb-367926170a05",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-11-04T13:38:34.3710899+01:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "ef3038a9-f64c-4e62-92a0-336144d063f5",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-11-04T13:38:34.3710899+01:00",
"PolicyId": 8
},
{
"$ref": "12"
}
],
"PriceGroupPolicies": [
{
"$id": "13",
"Id": 1,
"GroupId": 2,
"BuyLimit": 3,
"MaxLimit": 4,
"DiscountAmount": 5.0,
"TotalAmount": 6.0,
"Updated": "2026-11-04T13:38:34.3710899+01:00"
},
{
"$ref": "13"
}
],
"Photo": "QEA=",
"GroupPrice": 72.0,
"ExternalId": "sample string 73",
"IngredientQty": 74.0,
"StockQty": 75.0,
"Attributes": "sample string 76",
"LocalStockNull": true,
"StockInitialCount": 78.0,
"Selected": true,
"ShowWarhouseStock": true,
"ShowStockQty": true,
"HideStockQty": false,
"IsRUT": true,
"NotSelected": true,
"IsInActive": true,
"CreatedBy": "sample string 84",
"TerminalId": "3f1ecf02-7d47-4db3-97ba-b298846c904e",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "66dc2d69-3d91-4861-8528-d0fd33b7f628",
"PriceAdd": 90.0,
"PriceRemove": 91.0,
"FreeQty": 92.0,
"MinQty": 93.0,
"MaxQty": 94.0,
"FirstItemSelected": true,
"OptionForOrderType": 0,
"PLUNumeric": 0,
"ScalePrice": 96.0,
"Files": [
{
"$id": "14",
"UUID": "fc092bf4-02be-4f16-843d-2742002b2b29",
"ParentUUID": "ab9e7333-4c30-4102-9067-324bebd8043b",
"EntityUUID": "166c1fdc-7d9d-4532-a190-79e278b18fdc",
"EntityType": "sample string 3",
"ClientFilename": "sample string 4",
"ServerFilename": "sample string 5",
"ContentType": "sample string 6",
"ContentSubType": "sample string 7",
"FileSize": 8,
"Location": "sample string 9",
"Url": "sample string 10",
"ThumbnailUrl": "sample string 11",
"MetaData": "sample string 12",
"CreatedByUUID": "sample string 13",
"CreatedAt": "2026-11-04T13:38:34.3710899+01:00",
"UpdatedAt": "2026-11-04T13:38:34.3710899+01:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-11-04T13:38:34.3710899+01:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemTypeText": "Individual",
"ItemUnitText": "Piece",
"LanguageTexts": [
{
"$id": "15",
"Id": "2fad8fd3-b3bc-4ea7-8d8a-34c7c296a851",
"ItemId": "db569320-4680-4195-ac78-dcc70683e130",
"LanguageId": 3,
"Name": "sample string 4",
"ShortDescription": "sample string 5",
"LongDescription": "sample string 6",
"Updated": "2026-11-04T13:38:34.3710899+01:00"
},
{
"$ref": "15"
}
],
"ItemAdditionalIdentifications": [
{
"$id": "16",
"UUID": "c68e3608-d8fc-4685-bc57-7341b3f4d61a",
"ItemUUID": "c892a3ba-af27-429f-80b9-c5bee18a8be2",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-11-04T13:38:34.3710899+01:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-11-04T13:38:34.3710899+01:00",
"updatedByUUID": "sample string 8"
},
{
"$ref": "16"
}
],
"IsManageStock": false,
"PriceExlTax": 20.23,
"IndexId": 97,
"IsSelected": true,
"HideQuantityUnit": true
}