GET api/Product/GetProductById?id={id}
Get Product by Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Item Id as Parameter |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Model of ProductData that includes List of Products, Categories and Item Campaing , Accouting
ProductDataName | Description | Type | Additional information |
---|---|---|---|
Products | Collection of Product |
None. |
|
Categories | Collection of Category |
None. |
|
ItemCategories | Collection of ItemCategory |
None. |
|
Accountings | Collection of Accounting |
None. |
|
ItemCampaigns | Collection of ItemCampaign |
None. |
|
ItemGroups | Collection of ItemGroup |
None. |
|
ProductPrices | Collection of ProductPrice |
None. |
|
PricePolicies | Collection of Item_PricePolicy |
None. |
|
ItemStocks | Collection of ItemStock |
None. |
|
PolicyGroups | Collection of PolicyGroup |
None. |
|
PriceGroupPolicies | Collection of PriceGroupPolicy |
None. |
|
ItemPolicyGroups | Collection of Item_PolicyGroup |
None. |
|
ItemIngredients | Collection of ItemIngredient |
None. |
|
ItemConfigurations | Collection of ItemConfiguration |
None. |
|
ItemDiscountedPrices | Collection of ItemDiscountedPrice |
None. |
|
ItemInventories | Collection of ItemInventory |
None. |
|
CampaignPriceLists | Collection of CampaignPriceList |
None. |
|
ServeTypes | Collection of ServeType |
None. |
|
ServeFlows | Collection of ServeFlow |
None. |
|
ServeFlowTypes | Collection of ServeFlowType |
None. |
|
ItemPrinters | Collection of ItemPrinter |
None. |
|
PriceLists | Collection of PriceList |
None. |
|
ItemPriceLists | Collection of ItemPriceList |
None. |
|
CampaignMasters | Collection of CampaignMaster |
None. |
|
CampaignPriceDetails | Collection of CampaignPriceDetail |
None. |
|
ProductCampaigns | Collection of ProductCampaign |
None. |
|
CategoryItemGroups | Collection of CategoryItemGroup |
None. |
|
ItemOptionGroups | Collection of ItemOptionGroup |
None. |
|
ItemOptions | Collection of ItemOption |
None. |
|
ItemOptionGroupOptions | Collection of ItemOptionGroupOption |
None. |
|
ItemOutletStatuses | Collection of ItemOutletStatus |
None. |
Response Formats
application/json, text/json
Sample:
{ "Products": [ { "$id": "2", "Id": "b849b5db-f9dc-4f9e-9a0b-cea41f6ebe9d", "SKU": "sample string 2", "Name": "sample string 3", "Description": "sample string 4", "LongDescription": "sample string 5", "BarCode": "sample string 6", "Price": 7.0, "PurchasePrice": 8.0, "Tax": 9.0, "BrandId": 10, "PLU": "sample string 11", "Unit": 0, "AskPrice": true, "AskWeight": true, "PriceLock": true, "ColorCode": "sample string 15", "PrinterId": 16, "PlaceHolder": true, "AskVolume": true, "NeedIngredient": true, "Bong": true, "Sticky": 21, "Seamless": true, "ShowItemButton": true, "ShowGroupItem": true, "AccountingId": 25, "ReceiptMethod": 0, "ItemType": 0, "DiscountAllowed": true, "PreparationTime": 0, "IngredientPopup": true, "DefaultCartQty": 28.0, "SortOrder": 29, "IconId": 30, "Active": true, "Deleted": true, "Weight": 33.0, "Availability": true, "TextColor": "sample string 35", "ServeType": 64, "BongTitle": "sample string 37", "Synced": true, "DemandIdControl": true, "Discontinued": true, "AskPLU": true, "SupplierId": "4a109b83-bc5c-4554-a8b2-74513b25efd9", "SupplierSKU": "sample string 44", "DefaultUnit": 0, "ManageStock": 45, "PriceRek": 46.0, "CommentsRequired": true, "TicketQty": 48, "MinCartQty": 49.0, "MinQtyAlert": 50.0, "GroupId": "037f22cf-1cb7-4aaf-a256-8ea2a7f02fc6", "ComissionPercent": 51.0, "PantPrice": 52.0, "TrackAmount": true, "SaleUnitSuffix": "sample string 54", "QtyPerSaleUnit": 55.0, "Created": "2024-05-17T01:09:44.9029449+02:00", "Updated": "2024-05-17T01:09:44.9029449+02:00", "UpdatedBy": "e401f182-2cf5-4707-acf5-2ccd0566af44", "CategoryId": 58, "Campaign": { "$id": "3", "Id": "9a788514-a2a3-4d5c-bd55-c9ec2df2f2c1", "CampaignType": 0, "DiscountBy": 0, "BuyLimit": 2, "FreeOffer": 3, "Price": 4.0, "DiscountQtyIncrement": 5, "Description": "sample string 6", "StartDate": "2024-05-17T01:09:44.9029449+02:00", "EndDate": "2024-05-17T01:09:44.9029449+02:00", "Deleted": true, "Updated": "2024-05-17T01:09:44.9029449+02:00", "CampaignPriceDetails": [ { "$id": "4", "Id": "fe83efa8-61c8-4ce7-9a75-88cb620e1763", "CampaignId": "57f54716-32a8-4573-a2f5-7af74bc25653", "Quantity": 3, "PayPrice": 4.0, "Deleted": true, "Updated": "2024-05-17T01:09:44.9029449+02:00" }, { "$ref": "4" } ] }, "HasPricePolicy": true, "ItemCategory": [ { "$id": "5", "Id": 1, "ItemId": "a88890ce-da2f-4000-88f3-faa255de8a19", "CategoryId": 3, "SortOrder": 4, "IsPrimary": true }, { "$ref": "5" } ], "ItemIdex": 60, "PolicyGroupId": 61, "HasCampaign": true, "Products": [ { "$ref": "2" }, { "$ref": "2" } ], "ColorName": "sample string 62", "Type": 63, "ImagePath": "sample string 64", "ImageVisibility": true, "ifExists": "sample string 66", "ProductPrices": [ { "$id": "6", "Id": 1, "ItemId": "1c5cef51-0e60-499e-b1e0-8c3c6db1c4a4", "PurchasePrice": 3.0, "Price": 4.0, "OutletId": "4bb55337-5335-4ab8-9c73-1c4a4ae825c3", "PriceMode": 0, "Updated": "2024-05-17T01:09:44.9029449+02:00" }, { "$ref": "6" } ], "Ingredients": [ { "$ref": "2" }, { "$ref": "2" } ], "Variants": [ { "$id": "7", "Id": 1, "ConfigurationId": "cc094028-fbe0-4e32-a9fd-12e801304d87", "ItemId": "b00b46d8-6c04-4c68-803d-7956a0ff31e7", "SortOrder": 4, "Deleted": true, "Updated": "2024-05-17T01:09:44.9029449+02:00" }, { "$ref": "7" } ], "ItemOption": [ { "$id": "8", "Id": "c2355543-6dce-4584-a2b9-1e7375986413", "ItemOptionGroupId": "66f72258-c6bd-4fac-b454-de8e3439cd84", "ItemId": "9c370a6c-884a-4196-86cf-92b31fbd12ff", "CategoryId": 4, "Active": true, "Updated": "2024-05-17T01:09:44.9029449+02:00" }, { "$ref": "8" } ], "ShowOnReceipt": true, "QuickAdd": true, "HasIngredients": true, "CategoryItemGroups": [ { "$id": "9", "Id": "5781956f-3442-4395-b7a0-17ff1e3a6911", "CategoryId": 2, "GroupId": "ae8d95a8-d10c-4b2a-ada5-97887596e4aa", "Qty": 4.0, "Price": 5.0, "Deleted": true, "SortOrder": 7, "Updated": "2024-05-17T01:09:44.9029449+02:00", "Description": "sample string 9" }, { "$ref": "9" } ], "ItemPricePolicies": [ { "$id": "10", "Id": 1, "ItemId": "7c002951-dacc-40b0-b46d-351ed02a6136", "BuyLimit": 3, "DiscountAmount": 4.0, "Active": true, "Deleted": true, "Updated": "2024-05-17T01:09:44.9029449+02:00", "PolicyId": 8 }, { "$ref": "10" } ], "PriceGroupPolicies": [ { "$id": "11", "Id": 1, "GroupId": 2, "BuyLimit": 3, "MaxLimit": 4, "DiscountAmount": 5.0, "TotalAmount": 6.0, "Updated": "2024-05-17T01:09:44.9029449+02:00" }, { "$ref": "11" } ], "Photo": "QEA=", "GroupPrice": 69.0, "ExternalId": "sample string 70", "IngredientQty": 71.0, "StockQty": 72.0, "StockInitialCount": 73.0, "Selected": true, "ShowWarhouseStock": true, "ShowStockQty": true, "HideStockQty": false, "IsRUT": true, "NotSelected": true, "IsInActive": true, "CreatedBy": "sample string 79", "TerminalId": "1936cfa3-b715-4b9c-a826-85a66871884b", "CategoryName": "sample string 80", "ShowCategoryName": true, "DiscountedPrice": 81.0, "Qty": 82.0, "ConfigurationId": 83, "ItemOptionId": "fbf0a494-8226-443d-82d8-4e7472a91ecf", "PriceAdd": 85.0, "PriceRemove": 86.0, "FreeQty": 87.0, "PLUNumeric": 0, "ScalePrice": 88.0, "PriceExlTax": 7.63 }, { "$ref": "2" } ], "Categories": [ { "$id": "12", "Id": 1, "Name": "sample string 2", "Parant": 3, "CategoryLevel": 4, "Type": 0, "Active": true, "Deleted": true, "Created": "2024-05-17T01:09:44.9029449+02:00", "Updated": "2024-05-17T01:09:44.9029449+02:00", "ColorCode": "sample string 8", "TextColorCode": "sample string 9", "ItemColorCode": "sample string 10", "ApplyItemColor": true, "SortOrder": 12, "IconId": 13, "ReportOrder": 14, "AccountingId": 15, "SortItemByName": true, "ComissionPercent": 17.0, "ShowButton": true, "SubCategories": [ { "$ref": "12" }, { "$ref": "12" } ], "Children": [ { "$ref": "12" }, { "$ref": "12" } ], "Photo": "QEA=", "ImageURL": "sample string 19", "IsPrimary": true, "IsParent": true, "IsSelected": true }, { "$ref": "12" } ], "ItemCategories": [ { "$ref": "5" }, { "$ref": "5" } ], "Accountings": [ { "$id": "13", "Id": 1, "AcNo": 2, "Name": "sample string 3", "IsDeleted": true, "TAX": 5.0, "AccountType": 0, "Updated": "2024-05-17T01:09:44.9029449+02:00", "SortOrder": 7 }, { "$ref": "13" } ], "ItemCampaigns": [ { "$id": "14", "Id": 1, "ItemId": "52b9f268-bf28-447b-92d0-d5dc0e8da03a", "CampaignId": 3, "StartDate": "2024-05-17T01:09:44.9039433+02:00", "EndDate": "2024-05-17T01:09:44.9039433+02:00", "Active": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "14" } ], "ItemGroups": [ { "$id": "15", "Id": 1, "ItemId": "051de1c2-2825-4d80-b451-fdbf4135aff3", "GroupId": "7e0fbab1-ceb0-4133-bccb-074574ae96aa", "Qty": 4.0, "Price": 5.0, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00", "Description": "sample string 8", "Bong": true, "PrinterId": 10, "ItemType": 0, "ServeType": 64, "Tax": 12.0, "DiscountAllowed": true }, { "$ref": "15" } ], "ProductPrices": [ { "$ref": "6" }, { "$ref": "6" } ], "PricePolicies": [ { "$ref": "10" }, { "$ref": "10" } ], "ItemStocks": [ { "$id": "16", "Id": 1, "ItemId": "0ec74d79-9574-47b8-9125-b9e41dd8ed12", "Quantity": 3.0, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "16" } ], "PolicyGroups": [ { "$id": "17", "Id": 1, "Title": "sample string 2", "Updated": "2024-05-17T01:09:44.9039433+02:00", "GroupPolicies": [ { "$ref": "11" }, { "$ref": "11" } ] }, { "$ref": "17" } ], "PriceGroupPolicies": [ { "$ref": "11" }, { "$ref": "11" } ], "ItemPolicyGroups": [ { "$id": "18", "Id": 1, "ItemId": "da3503ae-da04-4e0d-8085-a6bec74d8ca6", "GroupId": 3, "Active": true, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "18" } ], "ItemIngredients": [ { "$id": "19", "Id": 1, "ItemId": "c858eb18-4c10-4178-a909-26163bdff7a5", "IngredientId": "ba6f3359-1b30-488e-9a6b-c3a78a358cc2", "ShowOnReceipt": true, "QuickAdd": true, "Qty": 6.0, "Unit": 0, "Price": 7.0, "SortOrder": 8, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "19" } ], "ItemConfigurations": [ { "$ref": "7" }, { "$ref": "7" } ], "ItemDiscountedPrices": [ { "$id": "20", "Id": 1, "ItemId": "d3862c56-7a44-427d-bca0-a4381e80bfee", "Price": 3.0, "StartDate": "2024-05-17T01:09:44.9039433+02:00", "EndDate": "2024-05-17T01:09:44.9039433+02:00", "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "20" } ], "ItemInventories": [ { "$id": "21", "ItemInventoryID": "28436eaa-2bf9-4290-b7d8-1c77a90cb8a6", "ItemId": "0e8a98dc-519e-410a-9f3b-a6c9ad70d165", "WarehouseID": "becabbc1-f598-4ddb-9035-8f60d253bd6e", "WarehouseLocationID": "c27c356c-9c33-4da8-9273-9b51d7251c27", "StockCount": 5.0, "StockReservations": 6.0, "Synced": true, "Updated": "2024-05-17T01:09:44.9039433+02:00", "Direction": 9 }, { "$ref": "21" } ], "CampaignPriceLists": [ { "$id": "22", "Id": 1, "CampaignId": 2, "Quantity": 3, "PayPrice": 4.0, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "22" } ], "ServeTypes": [ { "$id": "23", "Id": 64, "Name": "sample string 2", "SortOrder": 3, "ColorCode": "sample string 4", "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "23" } ], "ServeFlows": [ { "$id": "24", "Id": 64, "Name": "sample string 2", "StartAutomatically": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "24" } ], "ServeFlowTypes": [ { "$id": "25", "Id": 1, "FlowId": 64, "ServeTypeId": 64, "SortOrder": 4, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "25" } ], "ItemPrinters": [ { "$id": "26", "Id": "9198a8d1-c86d-4c64-b208-3eac565f5dc0", "ItemId": "0506aa8d-8ba2-406e-a9b0-2b71d62d4ccc", "OutletId": "ba74fbd1-89d3-484c-be38-91aa8de589a6", "TerminalId": "8719efad-ca2b-40ef-95c0-32ede9e8d70e", "PrinterId": 5, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "26" } ], "PriceLists": [ { "$id": "27", "Id": "daa36229-09a1-4ef5-9273-3aaaf6491236", "Code": "sample string 2", "Name": "sample string 3", "Comment": "sample string 4", "IsDefault": true, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "27" } ], "ItemPriceLists": [ { "$id": "28", "Id": "768fc914-6ece-4c39-b778-5271f363891d", "PriceListId": "671cef1b-dc27-4429-8bcf-4513b8069005", "ItemId": "7766d927-dc91-433c-bea1-6a9e852b28dc", "Price": 4.0, "Quantity": 5.0, "ValidFrom": "2024-05-17T01:09:44.9039433+02:00", "ValidTo": "2024-05-17T01:09:44.9039433+02:00", "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00", "Code": "sample string 10", "Name": "sample string 11" }, { "$ref": "28" } ], "CampaignMasters": [ { "$ref": "3" }, { "$ref": "3" } ], "CampaignPriceDetails": [ { "$ref": "4" }, { "$ref": "4" } ], "ProductCampaigns": [ { "$id": "29", "Id": "75eec993-5f02-47c7-9f3c-814341cb4e79", "ItemId": "969a2064-9599-4227-80de-b4d6a71d7d26", "CampaignId": "12c02b9d-04ad-4e59-9d57-c97392b33e20", "StartDate": "2024-05-17T01:09:44.9039433+02:00", "EndDate": "2024-05-17T01:09:44.9039433+02:00", "Active": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "29" } ], "CategoryItemGroups": [ { "$ref": "9" }, { "$ref": "9" } ], "ItemOptionGroups": [ { "$id": "30", "Id": "74e81256-c05d-4156-bbf0-af6fdc013d6f", "Name": "sample string 2", "Description": "sample string 3", "FreeQty": 4.0, "PriceAdd": 5.0, "PriceRemove": 6.0, "Placement": 0, "Deleted": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "30" } ], "ItemOptions": [ { "$ref": "8" }, { "$ref": "8" } ], "ItemOptionGroupOptions": [ { "$id": "31", "Id": "681f7b37-9505-4cab-9894-81a38a4dedad", "ItemOptionGroupId": "702c5440-cc0e-4213-83a2-b1bd9ebb9bd5", "ItemId": "5eb364d9-bada-4000-b87c-de9252bc2308", "UsePriceFromGroup": true, "PriceAdd": 5.0, "PriceRemove": 6.0, "Active": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "31" } ], "ItemOutletStatuses": [ { "$id": "32", "Id": "69295155-c19d-4457-8f2c-5d0dfab6c9b6", "ItemId": "963bb2f5-61bf-4594-9f39-1dac07252e8f", "OutletId": "30eb81f8-d83d-4e2f-91d8-c4f20157c819", "Active": true, "Updated": "2024-05-17T01:09:44.9039433+02:00" }, { "$ref": "32" } ] }