POST api/Product/AddProduct
Request Information
URI Parameters
None.
Body Parameters
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. |
Request Formats
application/json, text/json
{
"Id": "dd6d170c-576a-4b23-889c-19050386671c",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "6c814364-c1bc-45ae-bc4c-81252d9ee151",
"SupplierId": "4f5bd779-530f-4b10-9b72-246b3600127f",
"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-09-20T05:43:36.3905357+02:00",
"SpecialSalesPriceValidTo": "2026-09-20T05:43:36.3905357+02:00",
"Draft": true,
"VatChangeBehavior": 0,
"ItemTypeUUID": "662bf70a-2e2d-4b43-a683-bcd6fac4373f",
"ItemGroupUUID": "c9745629-687b-4c90-ae50-18c6bf0a904e",
"ItemAttributeSetUUID": "eecc9fa2-e4ff-4061-8a97-1c1776480b05",
"BrandUUID": "39b94e41-f115-4cfc-a6f9-58c82b26bfda",
"TicketTemplateId": 1,
"Created": "2026-09-20T05:43:36.3905357+02:00",
"Updated": "2026-09-20T05:43:36.3905357+02:00",
"UpdatedBy": "dbecf513-9e5f-4da6-b7e7-9af704276df4",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "342b53ee-f9a8-44be-abdc-586315571509",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-09-20T05:43:36.3905357+02:00",
"EndDate": "2026-09-20T05:43:36.3905357+02:00",
"Deleted": true,
"Updated": "2026-09-20T05:43:36.3905357+02:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "31d6745f-f993-4e1a-b963-6986105c7fb2",
"CampaignId": "de1931b6-11ac-4830-900f-0e2e75e8fddd",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-09-20T05:43:36.3905357+02:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "8ded485e-4206-4c56-b91e-4e0aa0ee9cd4",
"TagId": "fab7d98d-9e94-4294-a5f9-fccc5864a6a0",
"ItemId": "5f5e276c-0a6c-4ffc-ac9e-e2c83bd47cee",
"Deleted": true,
"Synced": true,
"Updated": "2026-09-20T05:43:36.3905357+02:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "2ca7dfbb-fa40-45c1-8744-959f10fca4df",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-09-20T05:43:36.3905357+02:00",
"EndDate": "2026-09-20T05:43:36.3905357+02:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-09-20T05:43:36.3905357+02:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-09-20T05:43:36.3905357+02:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-09-20T05:43:36.3905357+02:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "e14eab15-78b8-43d7-bcf4-1070a448eaa8",
"PriceListUUID": "3cea9fc3-6c2d-49c6-a4ba-3a17c2916e0a",
"ItemGroupUUID": "d9462f68-24d4-4a5a-a4f3-a8f2d87a6bb6",
"AgreementUUID": "c8767edb-5831-43db-b5b9-e04d1c014f8a",
"CustomerGroupUUID": "e789e61e-d55e-413d-aaba-4dfc2f4f1bfd",
"CustomerUUID": "34d61a02-0736-4846-8916-9d75583ff157",
"ProjectUUID": "5d8b34d9-091d-4563-98d0-43c5e313f921",
"CampaignUUID": "66813898-102e-420c-ad24-db8fa4f60eeb",
"ItemUUID": "4afc7b7a-33e5-4bb5-b949-a86c51e6d0a8",
"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-09-20T05:43:36.3905357+02:00",
"ValidTo": "2026-09-20T05:43:36.3905357+02:00",
"CreatedAt": "2026-09-20T05:43:36.3905357+02:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-09-20T05:43:36.3905357+02:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-09-20T05:43:36.3905357+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": "1cca76e3-419e-4366-967f-53652e7e4a8d",
"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": "00f54b6b-3101-4843-a705-75400aaf7908",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "aadc0e43-158c-4c9b-aa23-085434b0537b",
"PriceMode": 0,
"Updated": "2026-09-20T05:43:36.3905357+02:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "e5343c03-7eb3-4ded-8373-a590fa8aa801",
"ItemId": "3a9c0274-99d1-41c5-a6b4-0a6c93d50ae3",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-09-20T05:43:36.3905357+02:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "0cf5d01f-01b2-4c1d-99d3-6eb7721ddb05",
"ItemOptionGroupId": "ab66832a-5426-4c7e-8986-3d47f1697692",
"ItemId": "dbeb39c5-873d-48f8-a96b-ee0ce2491cb9",
"CategoryId": 4,
"Active": true,
"Updated": "2026-09-20T05:43:36.3905357+02:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "041afeef-fa30-42fe-a30a-cdd08bc16f81",
"CategoryId": 2,
"GroupId": "f0890ccb-3112-44dc-b853-35a5ffcd9dfa",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-09-20T05:43:36.3905357+02:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "b5d4bf97-969b-4310-b5e7-7a36686d4e4b",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-09-20T05:43:36.3905357+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-09-20T05:43:36.3905357+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": "ca20cc9a-8228-4f82-82c5-c988861658dc",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "5b15b5c1-4701-4b05-b9be-b73d3133215f",
"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": "9f931631-3963-47cf-87c8-25b9c3d2c367",
"ParentUUID": "6513abdb-f3bc-42ec-9421-1974562423f1",
"EntityUUID": "b38ac7f9-d6e1-49ef-a80f-46ec4d8ab255",
"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-09-20T05:43:36.406164+02:00",
"UpdatedAt": "2026-09-20T05:43:36.406164+02:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-09-20T05:43:36.406164+02:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemTypeText": "Individual",
"ItemUnitText": "Piece",
"ItemAdditionalIdentifications": [
{
"$id": "15",
"UUID": "0b8c6929-c540-4140-bfcb-d26e347e52fe",
"ItemUUID": "fb28f3d3-6c65-4c85-b029-75f90efd903b",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-09-20T05:43:36.406164+02:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-09-20T05:43:36.406164+02:00",
"updatedByUUID": "sample string 8"
},
{
"$ref": "15"
}
],
"IsManageStock": false,
"PriceExlTax": 20.23,
"IndexId": 97,
"IsSelected": true,
"HideQuantityUnit": true
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
true