POST api/Product/PostProduct
Post Product added at NIMPOS side
Request Information
URI Parameters
None.
Body Parameters
Product Model
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. |
|
| 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. |
|
| 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": "41a3daf2-222c-47e1-9e57-f4f41e9df8a6",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "7ee545c4-c250-41e0-b3d9-e1c4d8a1d2c7",
"SupplierId": "1c64b5d6-2731-4ab3-926c-79c0bc21083d",
"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-03-21T23:45:45.0698221+01:00",
"SpecialSalesPriceValidTo": "2026-03-21T23:45:45.0698221+01:00",
"Draft": true,
"Created": "2026-03-21T23:45:45.0698221+01:00",
"Updated": "2026-03-21T23:45:45.0698221+01:00",
"UpdatedBy": "f9c52b4d-806c-43c7-a2e3-3799490f75d4",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "bdcbb799-273f-4cdc-ba25-943764bfba4a",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-03-21T23:45:45.0698221+01:00",
"EndDate": "2026-03-21T23:45:45.0698221+01:00",
"Deleted": true,
"Updated": "2026-03-21T23:45:45.0698221+01:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "d155744c-8e7b-4c21-9cd2-b02d9e6d2353",
"CampaignId": "ac5989b0-cc9c-4f8c-bb8f-94ac03d23ac5",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-03-21T23:45:45.0698221+01:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "5c775465-5ec1-43b3-afd1-9717a99a457a",
"TagId": "c16c91b8-a08c-4f60-bcf7-0e4575843420",
"ItemId": "d120fee9-2bb1-414e-bf1a-7a86ca80258b",
"Deleted": true,
"Synced": true,
"Updated": "2026-03-21T23:45:45.0698221+01:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "f241f5c0-4ec6-4120-af7f-7a0524d56c5e",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-03-21T23:45:45.0698221+01:00",
"EndDate": "2026-03-21T23:45:45.0698221+01:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-03-21T23:45:45.0698221+01:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-03-21T23:45:45.0698221+01:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-03-21T23:45:45.0698221+01:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "015adca1-171f-49b7-a3ce-c8d82e45b46b",
"PriceListUUID": "5a20b251-152d-43c0-bb47-93840c575e3f",
"ItemGroupUUID": "dab30c17-7916-4e17-8133-3c67ca11b605",
"AgreementUUID": "6a18f973-398f-46e8-9c50-b599537741ce",
"CustomerGroupUUID": "bd52fd06-c813-40df-8a27-11999eb87104",
"CustomerUUID": "332f5450-8b5f-4ede-bde6-6c74fc2351b9",
"ProjectUUID": "ef230b29-ff27-418f-af91-3e87cda02f7a",
"CampaignUUID": "6dcd8894-22ed-4725-abad-85485d565385",
"ItemUUID": "225185a3-e237-45a2-8b0b-3a50eece5fa3",
"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-03-21T23:45:45.0698221+01:00",
"ValidTo": "2026-03-21T23:45:45.0698221+01:00",
"CreatedAt": "2026-03-21T23:45:45.0698221+01:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-03-21T23:45:45.0698221+01:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-03-21T23:45:45.0698221+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": "f2d7a91d-0cd9-4b6a-95e1-ecd0ce80b891",
"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": "a08ba7e3-966b-47eb-a324-2329e6082bc0",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "f1696d89-1e56-49fc-9352-aae5413bb8c4",
"PriceMode": 0,
"Updated": "2026-03-21T23:45:45.0698221+01:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "c0c73e93-e12a-4d74-9d2d-3f6993a00bf2",
"ItemId": "a8895a2e-02f4-40db-a03f-41154ab29f68",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-03-21T23:45:45.0698221+01:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "0744a677-a240-46e9-8247-c1eb088ee1c5",
"ItemOptionGroupId": "1bc1ae13-0783-498f-bacb-0a8ffa78bd57",
"ItemId": "54c25ea4-e840-459b-89e0-c9a3ecf635fe",
"CategoryId": 4,
"Active": true,
"Updated": "2026-03-21T23:45:45.0698221+01:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "b5bfbf65-e086-4b0a-b5b3-ee6b649b6af3",
"CategoryId": 2,
"GroupId": "58fa579f-bf1e-4bda-9443-d974158e16eb",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-03-21T23:45:45.0698221+01:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "314e9637-6781-45e5-8130-9f82821e1ba3",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-03-21T23:45:45.0698221+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-03-21T23:45:45.0698221+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": "fa28219c-61ff-4862-a60d-eeba260736c1",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "305f0117-749d-4b1a-b2f3-a111ff0ff51b",
"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": "8ac58d6c-b276-46d6-966d-1032580d5b87",
"ParentUUID": "811edb23-c434-4a1e-98f6-cc2b3e0a437d",
"EntityUUID": "bbdffe56-de21-4619-a416-97a66d70b0f5",
"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-03-21T23:45:45.0698221+01:00",
"UpdatedAt": "2026-03-21T23:45:45.0698221+01:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-03-21T23:45:45.0698221+01:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemAdditionalIdentifications": [
{
"$id": "15",
"UUID": "9c710bc1-602c-4f4c-b2a3-33fabdebe22c",
"ItemUUID": "3e248913-18eb-45da-ad47-671fe6de92b1",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-03-21T23:45:45.0698221+01:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-03-21T23:45:45.0698221+01: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
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.