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": "4ee9fdba-3b6c-415d-a97d-f25491d79c39",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "7ad935d6-5331-465e-b3b7-99cd6c625537",
"SupplierId": "14ac8fbd-b659-4b2a-9ea8-355604241a68",
"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:20.6699287+02:00",
"SpecialSalesPriceValidTo": "2026-08-05T06:21:20.6699287+02:00",
"Draft": true,
"VatChangeBehavior": 0,
"ItemTypeUUID": "9f62e05a-d888-4dac-9b99-b7a651c51db0",
"ItemGroupUUID": "cfc43318-a50e-4be7-8a03-a3861c9d367b",
"ItemAttributeSetUUID": "ff9c6134-87bb-4c62-b911-f264049a10a9",
"BrandUUID": "96f8223d-ee01-45a2-bb0c-37556f3d52ed",
"TicketTemplateId": 1,
"Created": "2026-08-05T06:21:20.6699287+02:00",
"Updated": "2026-08-05T06:21:20.6699287+02:00",
"UpdatedBy": "b96ad17e-055b-4feb-9427-14d479ad0505",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "7bc649ac-1ab9-47df-b42f-8b1c9c9974d0",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-08-05T06:21:20.6699287+02:00",
"EndDate": "2026-08-05T06:21:20.6699287+02:00",
"Deleted": true,
"Updated": "2026-08-05T06:21:20.6699287+02:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "b00b983f-9566-472d-8af8-7ec13f5ffbe3",
"CampaignId": "03eab75e-43a2-4f68-92a5-8cc3cf2d2e06",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-08-05T06:21:20.6699287+02:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "381a95ea-7adc-499b-8cf8-48b11ff73fce",
"TagId": "974705e1-afef-47a6-b0e9-02bd6bba798a",
"ItemId": "ffc2c7a5-970a-4556-bf5c-a9c3ab932878",
"Deleted": true,
"Synced": true,
"Updated": "2026-08-05T06:21:20.6699287+02:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "5e847b95-6c92-41bb-8488-d0d72e69bfda",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-08-05T06:21:20.6699287+02:00",
"EndDate": "2026-08-05T06:21:20.6699287+02:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-08-05T06:21:20.6699287+02:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-08-05T06:21:20.6699287+02:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-08-05T06:21:20.6699287+02:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "7cc2e6f5-fcb8-43f9-b8b0-8a2eb733a244",
"PriceListUUID": "2c0d4f45-4e60-4b19-9d87-e33848f1afe3",
"ItemGroupUUID": "51309246-6149-4bf6-82e7-18c1eb2e8e97",
"AgreementUUID": "bc4bf23f-f987-4786-bc98-988852a0caa1",
"CustomerGroupUUID": "12c28bdf-9173-42b5-bbcb-8b6596430c87",
"CustomerUUID": "f21bc777-cec1-41d5-a607-e04c310e4133",
"ProjectUUID": "eba3344a-1345-4afb-9ff7-37b3a03f3925",
"CampaignUUID": "ed999f6e-0a73-4de3-b667-8e045d025fd2",
"ItemUUID": "b9057c09-82f0-43a8-acd4-e07ca8738cd2",
"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:20.6699287+02:00",
"ValidTo": "2026-08-05T06:21:20.6699287+02:00",
"CreatedAt": "2026-08-05T06:21:20.6699287+02:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-08-05T06:21:20.6699287+02:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-08-05T06:21:20.6699287+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": "942f90b0-7050-4405-9afb-428c7de0cba9",
"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": "9e3ba461-c40b-4d83-afc3-deeb1bf02fea",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "6a1f10f4-68aa-44f5-b422-8ed021a6da5a",
"PriceMode": 0,
"Updated": "2026-08-05T06:21:20.6699287+02:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "961b20bd-ed17-4b65-ba8e-6437fb06e85b",
"ItemId": "b32b3cf1-1829-43a6-802d-f4414f2e4613",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-08-05T06:21:20.6699287+02:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "36c07c19-4ec5-42a2-b3ef-b40c386145eb",
"ItemOptionGroupId": "c053d873-09a6-4ffc-acc5-bf6a2213e314",
"ItemId": "ebbee18f-276b-41ce-8136-832cdb4e0a6a",
"CategoryId": 4,
"Active": true,
"Updated": "2026-08-05T06:21:20.6699287+02:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "03705308-d64d-4b9d-ae7d-d3a285485175",
"CategoryId": 2,
"GroupId": "13f5302a-068b-48a1-942d-2c056c4b1a44",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-08-05T06:21:20.6699287+02:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "b0edc9e1-08f5-4578-9a67-cb14e69d6ea8",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-08-05T06:21:20.6699287+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:20.6699287+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": "85e24eef-8935-49be-81e8-37ec43718247",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "1660985d-eea7-49d4-88e1-37a0473b81ff",
"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": "f9a4d303-a872-4cf4-9d71-9c72fe215259",
"ParentUUID": "ae90a9e9-ecdd-40e5-bc45-766b7dda41b6",
"EntityUUID": "f4032107-1358-4538-942b-ada6f908cdb3",
"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:20.6699287+02:00",
"UpdatedAt": "2026-08-05T06:21:20.6699287+02:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-08-05T06:21:20.6699287+02:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemTypeText": "Individual",
"ItemUnitText": "Piece",
"ItemAdditionalIdentifications": [
{
"$id": "15",
"UUID": "07f8f42e-c504-4cf0-a447-0e8f47d9d6dc",
"ItemUUID": "edb9f626-bafc-4ba2-9386-f94fbc09be0a",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-08-05T06:21:20.6699287+02:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-08-05T06:21:20.6699287+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