POST api/Product/PostProduct
Post Product added at NIMPOS side
Request Information
URI Parameters
None.
Body Parameters
Product Model
ProductName | 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 |
Max length: 1000 |
|
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 |
|
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. |
|
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. |
|
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. |
|
PLUNumeric | integer |
None. |
|
ScalePrice | decimal number |
None. |
|
IsManageStock | boolean |
None. |
|
PriceExlTax | decimal number |
None. |
|
IndexId | integer |
None. |
|
IsSelected | boolean |
None. |
Request Formats
application/json, text/json
{ "Id": "e1d6453e-0888-4e82-a1a5-0d3b8407537a", "Name": "sample string 2", "SKU": "sample string 3", "BarCode": "sample string 4", "PLU": "sample string 5", "GroupId": "d6b2ef99-a9b4-419d-b034-b1cb1059ff8d", "SupplierId": "fa7b5064-88dd-48c2-b367-6bc781e67330", "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", "Created": "2025-07-04T14:05:51.8778554+02:00", "Updated": "2025-07-04T14:05:51.8778554+02:00", "UpdatedBy": "dccc40d4-97a4-4f09-8300-114e0c2a7791", "CategoryId": 60, "Campaign": { "$id": "2", "Id": "091a6270-d97c-4804-95a2-c865f26e302d", "CampaignType": 0, "DiscountBy": 0, "BuyLimit": 2, "FreeOffer": 3, "Price": 4.0, "DiscountQtyIncrement": 5, "Description": "sample string 6", "StartDate": "2025-07-04T14:05:51.8778554+02:00", "EndDate": "2025-07-04T14:05:51.8778554+02:00", "Deleted": true, "Updated": "2025-07-04T14:05:51.8778554+02:00", "CampaignPriceDetails": [ { "$id": "3", "Id": "987872a3-a316-4ba8-bbb0-afc01b9c8be3", "CampaignId": "7c47e603-8e5d-4027-9d71-245f987af5dc", "Quantity": 3, "PayPrice": 4.0, "Deleted": true, "Updated": "2025-07-04T14:05:51.8778554+02:00" }, { "$ref": "3" } ] }, "ItemsTags": [ { "$id": "4", "Id": "73ab9e53-4e12-454d-92d2-b7277983c238", "TagId": "59b4ba37-a9a9-4c41-a5dc-8d183b13e635", "ItemId": "edb1e111-746e-439e-b9fe-962a83782c5a", "Deleted": true, "Synced": true, "Updated": "2025-07-04T14:05:51.8778554+02:00", "TagName": "sample string 7" }, { "$ref": "4" } ], "ItemCampaign": { "$id": "5", "UUID": "c30932ae-7ed9-4063-b515-45c6e943cd66", "CampaignTypeId": "OPEN", "Title": "sample string 2", "DiscountBy": 1, "FreeOffer": 1, "BuyLimit": 1, "StartDate": "2025-07-04T14:05:51.8778554+02:00", "EndDate": "2025-07-04T14:05:51.8778554+02:00", "PriceEach": 1.0, "PriceTotal": 1.0, "Grouped": true, "CurrencyCode": "sample string 6", "IncludesVat": true, "CreatedAt": "2025-07-04T14:05:51.8778554+02:00", "CreatedByUUID": "sample string 9", "UpdatedAt": "2025-07-04T14:05:51.8778554+02:00", "UpdatedByUUID": "sample string 10", "DeletedAt": "2025-07-04T14:05:51.8778554+02:00", "DeletedByUUID": "sample string 11", "Synced": true, "ItemPrices": [ { "$id": "6", "UUID": "aaeaf42d-5a5e-4515-b0fd-050924b51562", "PriceListUUID": "e1fd8e53-b41a-4800-bc07-bfd8a4dc3728", "ItemGroupUUID": "aa556e2f-aaec-4417-8dc1-bf379f92bd35", "AgreementUUID": "e4a8248f-fa7f-4c28-a3dc-765774b5e33e", "CustomerGroupUUID": "c48c1848-91f0-440c-ae4e-09f58cb284ba", "CustomerUUID": "9fb070fa-6d8e-488c-97fd-54c09a475993", "ProjectUUID": "758ac819-bf33-45fc-b320-55a308c494c0", "CampaignUUID": "670daa5c-1336-444e-9d8a-a344143b4022", "ItemUUID": "b208d1b1-1ac6-49df-95a6-0f9e0e80bfbf", "WildCardSKU": "sample string 4", "MinQty": 1.0, "MaxQty": 1.0, "Price": 1.0, "Percentage": 1.0, "Type": "sample string 5", "RegularPrice": true, "ValidFrom": "2025-07-04T14:05:51.8778554+02:00", "ValidTo": "2025-07-04T14:05:51.8778554+02:00", "CreatedAt": "2025-07-04T14:05:51.8778554+02:00", "CreatedByUUID": "sample string 8", "UpdatedAt": "2025-07-04T14:05:51.8778554+02:00", "UpdatedByUUID": "sample string 9", "DeletedAt": "2025-07-04T14:05:51.8778554+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": "8111cf3c-a498-495e-8a0c-9cfd647ab480", "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": "2bb593b6-0958-4241-b6c3-6ef9b55b44e9", "PurchasePrice": 3.0, "Price": 4.0, "OutletId": "4253be5f-3f0d-4d2f-a26f-d93a3f9d3ce5", "PriceMode": 0, "Updated": "2025-07-04T14:05:51.8778554+02:00" }, { "$ref": "8" } ], "Ingredients": [ { "$ref": "1" }, { "$ref": "1" } ], "Variants": [ { "$id": "9", "Id": 1, "ConfigurationId": "d7a4e788-ad99-4de2-a318-9c9338d69749", "ItemId": "10b937be-12cc-41a5-9418-95a073f99aa6", "SortOrder": 4, "Deleted": true, "Updated": "2025-07-04T14:05:51.8778554+02:00" }, { "$ref": "9" } ], "ItemOption": [ { "$id": "10", "Id": "9aeeb6c4-a736-4d38-86d1-55e01afc036c", "ItemOptionGroupId": "c75c667a-c534-425d-b6e8-8d70ebc04c5c", "ItemId": "69004f8c-4b31-4d43-b247-f109f1e7d73e", "CategoryId": 4, "Active": true, "Updated": "2025-07-04T14:05:51.8778554+02:00" }, { "$ref": "10" } ], "ShowOnReceipt": true, "QuickAdd": true, "HasIngredients": true, "CategoryItemGroups": [ { "$id": "11", "Id": "d01225b3-ba01-4318-bef0-6231497d6a55", "CategoryId": 2, "GroupId": "b3701689-6d58-4313-b3af-b0dd06024881", "Qty": 4.0, "Price": 5.0, "Deleted": true, "SortOrder": 7, "Updated": "2025-07-04T14:05:51.8778554+02:00", "Description": "sample string 9" }, { "$ref": "11" } ], "ItemPricePolicies": [ { "$id": "12", "Id": 1, "ItemId": "38b68abd-07f6-4e49-bca4-d2da786350ee", "BuyLimit": 3, "DiscountAmount": 4.0, "Active": true, "Deleted": true, "Updated": "2025-07-04T14:05:51.8778554+02:00", "PolicyId": 8 }, { "$ref": "12" } ], "PriceGroupPolicies": [ { "$id": "13", "Id": 1, "GroupId": 2, "BuyLimit": 3, "MaxLimit": 4, "DiscountAmount": 5.0, "TotalAmount": 6.0, "Updated": "2025-07-04T14:05:51.8778554+02:00" }, { "$ref": "13" } ], "Photo": "QEA=", "GroupPrice": 71.0, "ExternalId": "sample string 72", "IngredientQty": 73.0, "StockQty": 74.0, "LocalStockNull": true, "StockInitialCount": 76.0, "Selected": true, "ShowWarhouseStock": true, "ShowStockQty": true, "HideStockQty": false, "IsRUT": true, "NotSelected": true, "IsInActive": true, "CreatedBy": "sample string 82", "TerminalId": "5d1034ea-c43c-4c3b-901c-e5d0b2c75e77", "CategoryName": "sample string 83", "ShowCategoryName": true, "DiscountedPrice": 84.0, "Qty": 85.0, "ConfigurationId": 86, "ItemOptionId": "f420f654-5169-4f6d-bf74-134828b94417", "PriceAdd": 88.0, "PriceRemove": 89.0, "FreeQty": 90.0, "MinQty": 91.0, "MaxQty": 92.0, "PLUNumeric": 0, "ScalePrice": 93.0, "IsManageStock": false, "PriceExlTax": 20.23, "IndexId": 94, "IsSelected": true }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.