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. |
|
| 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. |
|
| 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. |
|
| 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": "e45d0281-a951-43fe-bf23-e3d0d8b38531",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "2257e2e7-1472-42bc-83a9-658830fc603c",
"SupplierId": "3c85b41b-d42f-4068-8e96-f5472ffb36dd",
"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,
"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-08-05T06:21:16.0917634+02:00",
"SpecialSalesPriceValidTo": "2026-08-05T06:21:16.0917634+02:00",
"Draft": true,
"VatChangeBehavior": 0,
"ItemTypeUUID": "2e6157e7-d781-459e-9b9b-7f396ca66c53",
"ItemGroupUUID": "fc5618a5-867b-4ef2-9cd6-e8f8875b1605",
"ItemAttributeSetUUID": "443f894c-2572-430e-8b5d-07224ad0f793",
"BrandUUID": "d8dfc7b3-cc26-4c2e-9c35-157685682d15",
"TicketTemplateId": 1,
"Created": "2026-08-05T06:21:16.0917634+02:00",
"Updated": "2026-08-05T06:21:16.0917634+02:00",
"UpdatedBy": "ea5e99d8-62af-482e-87f2-87cb77c4fbad",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "796a483b-ba88-4b8b-b6f1-59fc842a140c",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-08-05T06:21:16.0917634+02:00",
"EndDate": "2026-08-05T06:21:16.0917634+02:00",
"Deleted": true,
"Updated": "2026-08-05T06:21:16.0917634+02:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "42a4c5f5-0c9f-4e18-921e-207d368d2b36",
"CampaignId": "d73c7388-89a8-4c6d-aa08-4bc4916fdebe",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-08-05T06:21:16.0917634+02:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "fee60e4f-3656-48ba-9f13-2a9d0905a706",
"TagId": "eaccf52a-4ff5-4941-bd14-301772f3f46b",
"ItemId": "9724155e-0abd-405f-988b-c9380890ff21",
"Deleted": true,
"Synced": true,
"Updated": "2026-08-05T06:21:16.0917634+02:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "af097fd3-5298-471e-854a-89713ec4ddc1",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-08-05T06:21:16.0917634+02:00",
"EndDate": "2026-08-05T06:21:16.0917634+02:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-08-05T06:21:16.0917634+02:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-08-05T06:21:16.0917634+02:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-08-05T06:21:16.0917634+02:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "892d3152-b378-45eb-94f1-15c8c6bdc6e0",
"PriceListUUID": "0ef391a4-96ca-431a-8e05-a06906485e2d",
"ItemGroupUUID": "da0aef9a-7a0b-466d-99c7-5cce6d35d95e",
"AgreementUUID": "2849ca3e-b84f-4854-95d6-ec843b8022c3",
"CustomerGroupUUID": "2e434e93-9aa0-4344-bc30-09791ab39cde",
"CustomerUUID": "1e8cc551-8634-4a1a-9663-7a22b98045f3",
"ProjectUUID": "deb40fcb-7714-4d37-9088-c178ffabd285",
"CampaignUUID": "340b2cca-0d14-491b-976d-d47e7e73d519",
"ItemUUID": "73014de5-e5eb-4da9-b805-09d01be31b53",
"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-08-05T06:21:16.0917634+02:00",
"ValidTo": "2026-08-05T06:21:16.0917634+02:00",
"CreatedAt": "2026-08-05T06:21:16.0917634+02:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-08-05T06:21:16.0917634+02:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-08-05T06:21:16.0917634+02: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": "daa4ea10-a8af-4471-a257-be57a5335692",
"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": "a01fd1c4-cd7f-4658-a24a-4966f14d5e25",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "5a9f43e6-33ba-468c-9952-d86b83041817",
"PriceMode": 0,
"Updated": "2026-08-05T06:21:16.0917634+02:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "19ccb112-7232-43ae-a1de-692ada2b9248",
"ItemId": "0ebb25ee-b48b-4bf2-b7cf-a83db8f4fb0e",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-08-05T06:21:16.0917634+02:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "ef165427-3641-4403-bad9-b8d4979449b5",
"ItemOptionGroupId": "681ebef9-1c1b-4f7a-ab7c-1bb556f1ab1a",
"ItemId": "cc224cca-de9f-41b2-8545-04cefd532b9d",
"CategoryId": 4,
"Active": true,
"Updated": "2026-08-05T06:21:16.0917634+02:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "b58f919c-46b3-42ac-b9fa-e13775d2d045",
"CategoryId": 2,
"GroupId": "0f9e530d-2e37-4798-a692-d2207b264d1a",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-08-05T06:21:16.0917634+02:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "fa1bb4b8-bbf2-48b3-b400-aa083b7adab8",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-08-05T06:21:16.0917634+02:00",
"PolicyId": 8
},
{
"$ref": "12"
}
],
"PriceGroupPolicies": [
{
"$id": "13",
"Id": 1,
"GroupId": 2,
"BuyLimit": 3,
"MaxLimit": 4,
"DiscountAmount": 5.0,
"TotalAmount": 6.0,
"Updated": "2026-08-05T06:21:16.0917634+02: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": "26f9aef5-6f11-4b6d-b9db-d51a4c718d4a",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "068280d8-c677-4416-b293-6154ca0b1a6a",
"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": "a9ba828b-ca29-4953-9829-1666e7546f2d",
"ParentUUID": "f52ae063-6943-4b87-91ab-626a980d055d",
"EntityUUID": "76e6a956-6ddf-42b9-bc51-d7ffc8d6d998",
"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-08-05T06:21:16.0917634+02:00",
"UpdatedAt": "2026-08-05T06:21:16.0917634+02:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-08-05T06:21:16.0917634+02:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemTypeText": "Individual",
"ItemUnitText": "Piece",
"ItemAdditionalIdentifications": [
{
"$id": "15",
"UUID": "73071fd0-0983-4926-bf9b-d0af3ce73839",
"ItemUUID": "f3cd6d28-f010-4799-90bd-7f52cf62a865",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-08-05T06:21:16.0917634+02:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-08-05T06:21:16.0917634+02:00",
"updatedByUUID": "sample string 8"
},
{
"$ref": "15"
}
],
"IsManageStock": false,
"PriceExlTax": 20.23,
"IndexId": 97,
"IsSelected": true,
"HideQuantityUnit": true
},
{
"$ref": "1"
}
]