GET api/Product/GetItems
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of 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": "1",
"Id": "01c167cb-aade-40a0-a4b8-f5e3a4f41da3",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "8ccee970-6980-4a19-a258-cc47e971a646",
"SupplierId": "cde623e4-764c-4611-9988-1fca56c686b4",
"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:37:07.8649178+01:00",
"SpecialSalesPriceValidTo": "2026-11-04T13:37:07.8649178+01:00",
"Draft": true,
"VatChangeBehavior": 0,
"ItemTypeUUID": "3d9befd7-0f40-4728-9473-4e135aecb10c",
"ItemGroupUUID": "12ed4a74-3e83-44c4-9c91-bfcd2cf576c8",
"ItemAttributeSetUUID": "4cec2444-d16e-4f8a-993e-6e7b099ed73c",
"BrandUUID": "20ac79ad-a531-4c20-8943-d906a439b225",
"TicketTemplateId": 1,
"OrderOptionType": 0,
"BestBeforeDays": 1,
"Created": "2026-11-04T13:37:07.8649178+01:00",
"Updated": "2026-11-04T13:37:07.8649178+01:00",
"UpdatedBy": "b196f67d-0280-48d5-b34f-1c39b1c7c075",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "b2ef4a3a-3dc2-4448-a494-d1d52f74e666",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-11-04T13:37:07.8649178+01:00",
"EndDate": "2026-11-04T13:37:07.8649178+01:00",
"Deleted": true,
"Updated": "2026-11-04T13:37:07.8649178+01:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "73fedf94-6a55-4be5-991a-bc598c6563ea",
"CampaignId": "64a78ecd-d2ac-4009-a41c-62b772a61b30",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-11-04T13:37:07.8649178+01:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "f5cc0353-dcd4-44dd-8bd3-fcca2eb8ca30",
"TagId": "209dc7f6-d55b-4de1-9bff-5971152426c9",
"ItemId": "7408e11b-0529-436e-b0a8-53744e6397aa",
"Deleted": true,
"Synced": true,
"Updated": "2026-11-04T13:37:07.8649178+01:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "84ac6b5e-fb1a-44c8-9f65-50310c92b15e",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-11-04T13:37:07.8649178+01:00",
"EndDate": "2026-11-04T13:37:07.8649178+01:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-11-04T13:37:07.8649178+01:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-11-04T13:37:07.8649178+01:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-11-04T13:37:07.8649178+01:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "05e4d51e-3e9c-40b3-bb97-c307dee5a1e6",
"PriceListUUID": "0f201a1d-7c37-4f2b-84b9-c6378e30dea4",
"ItemGroupUUID": "6d4aa472-a6e7-4281-89f7-7b8482a997f2",
"AgreementUUID": "4ffd30d0-7269-4014-b95c-8171c7493676",
"CustomerGroupUUID": "93950e9f-07d7-473b-a70b-96c7ce6d466e",
"CustomerUUID": "8ef04175-be81-4f03-a150-a98827ced767",
"ProjectUUID": "e68c65b0-6989-4765-8fc0-53feb04de8fe",
"CampaignUUID": "c765d3e5-1bdc-450d-9402-214d8e8fb184",
"ItemUUID": "b249e60f-b283-4515-99c5-5939b5196a95",
"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:37:07.8649178+01:00",
"ValidTo": "2026-11-04T13:37:07.8649178+01:00",
"CreatedAt": "2026-11-04T13:37:07.8649178+01:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-11-04T13:37:07.8649178+01:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-11-04T13:37:07.8649178+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": "a7a0f125-1a1f-4d87-9199-7a347be7154b",
"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": "4e1b897b-0205-4fd9-b9dd-4b8cf092466e",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "90a5ec43-4510-4512-8dd7-14797cebc434",
"PriceMode": 0,
"Updated": "2026-11-04T13:37:07.8649178+01:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "3fb6924a-677b-4ed6-a15b-4b443d53fd1e",
"ItemId": "3345caeb-3a80-4563-adad-56257ed3fd88",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-11-04T13:37:07.8649178+01:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "3d3377b2-b389-4e72-9e17-a484769a0198",
"ItemOptionGroupId": "5b103a42-54fe-4bdf-893a-7e5780dd1ad0",
"ItemId": "7fbbd08f-b27f-416e-99fb-454fa7b75ad5",
"CategoryId": 4,
"Active": true,
"Updated": "2026-11-04T13:37:07.8649178+01:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "8be00e4d-1853-40fc-a098-362805826495",
"CategoryId": 2,
"GroupId": "bf043227-0f3a-47ef-bb81-17e46da50d89",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-11-04T13:37:07.8649178+01:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "d74cec5c-7091-4062-bbc2-a4d21ef81589",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-11-04T13:37:07.8649178+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:37:07.8649178+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": "8d2c8991-8ce0-47b4-bfe2-75318fa3d541",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "e4b65267-0f4e-4767-b424-549403f94d88",
"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": "59e09aed-8378-40b7-94de-975d6369ff58",
"ParentUUID": "78903f43-377a-4a7f-ad41-55d9da56b83e",
"EntityUUID": "2c8d36e6-e3fa-407a-866b-3b1cf6ce0678",
"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:37:07.8649178+01:00",
"UpdatedAt": "2026-11-04T13:37:07.8649178+01:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-11-04T13:37:07.8649178+01:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemTypeText": "Individual",
"ItemUnitText": "Piece",
"LanguageTexts": [
{
"$id": "15",
"Id": "1fe31faf-d5e5-43c0-ac90-1527a2314b59",
"ItemId": "de836185-bfe2-433f-944d-5f55326f8bce",
"LanguageId": 3,
"Name": "sample string 4",
"ShortDescription": "sample string 5",
"LongDescription": "sample string 6",
"Updated": "2026-11-04T13:37:07.8649178+01:00"
},
{
"$ref": "15"
}
],
"ItemAdditionalIdentifications": [
{
"$id": "16",
"UUID": "5fd4500e-fb30-4dbe-ae0a-7060defac5a8",
"ItemUUID": "5ffb9c26-6322-471b-a569-c7770e93be64",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-11-04T13:37:07.8649178+01:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-11-04T13:37:07.8649178+01:00",
"updatedByUUID": "sample string 8"
},
{
"$ref": "16"
}
],
"IsManageStock": false,
"PriceExlTax": 20.23,
"IndexId": 97,
"IsSelected": true,
"HideQuantityUnit": true
},
{
"$ref": "1"
}
]