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": "157f0f45-03b5-4e92-8272-f5cdb1bd29d1",
"Name": "sample string 2",
"SKU": "sample string 3",
"BarCode": "sample string 4",
"PLU": "sample string 5",
"GroupId": "640df373-2a7d-4d27-96bd-9daed8402879",
"SupplierId": "90367069-32f2-45dc-b733-aaf4b7c7ac6f",
"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-02-04T04:13:23.8764615+01:00",
"SpecialSalesPriceValidTo": "2026-02-04T04:13:23.8764615+01:00",
"Draft": true,
"Created": "2026-02-04T04:13:23.8764615+01:00",
"Updated": "2026-02-04T04:13:23.8764615+01:00",
"UpdatedBy": "25ec796d-aaeb-4401-9f18-7bacad1064c6",
"CategoryId": 60,
"Campaign": {
"$id": "2",
"Id": "f29354c3-879a-437a-937b-3ce9383ec12d",
"CampaignType": 0,
"DiscountBy": 0,
"BuyLimit": 2,
"FreeOffer": 3,
"Price": 4.0,
"DiscountQtyIncrement": 5,
"Description": "sample string 6",
"StartDate": "2026-02-04T04:13:23.8764615+01:00",
"EndDate": "2026-02-04T04:13:23.8764615+01:00",
"Deleted": true,
"Updated": "2026-02-04T04:13:23.8764615+01:00",
"CampaignPriceDetails": [
{
"$id": "3",
"Id": "ce016b28-856c-48d8-a16c-7254f6321486",
"CampaignId": "34af751b-5f0b-40b1-9eeb-8f95cee0317c",
"Quantity": 3,
"PayPrice": 4.0,
"Deleted": true,
"Updated": "2026-02-04T04:13:23.8764615+01:00"
},
{
"$ref": "3"
}
]
},
"ItemsTags": [
{
"$id": "4",
"Id": "92f6e3ff-85aa-4a34-a792-2e98ccd12f04",
"TagId": "703497b6-ed37-4fb0-99a0-e1cd8809f847",
"ItemId": "1a45744f-b1aa-4e63-a8f8-8c0c97ed14fb",
"Deleted": true,
"Synced": true,
"Updated": "2026-02-04T04:13:23.8764615+01:00",
"TagName": "sample string 7"
},
{
"$ref": "4"
}
],
"ItemCampaign": {
"$id": "5",
"UUID": "a1141e27-a8d4-465a-b58b-6a26f697882c",
"CampaignTypeId": "OPEN",
"Title": "sample string 2",
"DiscountBy": 1,
"FreeOffer": 1,
"BuyLimit": 1,
"StartDate": "2026-02-04T04:13:23.8764615+01:00",
"EndDate": "2026-02-04T04:13:23.8764615+01:00",
"PriceEach": 1.0,
"PriceTotal": 1.0,
"Grouped": true,
"CurrencyCode": "sample string 6",
"IncludesVat": true,
"CreatedAt": "2026-02-04T04:13:23.8764615+01:00",
"CreatedByUUID": "sample string 9",
"UpdatedAt": "2026-02-04T04:13:23.8764615+01:00",
"UpdatedByUUID": "sample string 10",
"DeletedAt": "2026-02-04T04:13:23.8764615+01:00",
"DeletedByUUID": "sample string 11",
"Synced": true,
"ItemPrices": [
{
"$id": "6",
"UUID": "1bc3d543-fd2f-45d9-a2f5-68bb50bb1cf8",
"PriceListUUID": "fabf9eb1-16b5-47e2-8428-5189716b9c93",
"ItemGroupUUID": "58b28203-3472-49cd-a593-8166ec94c187",
"AgreementUUID": "6e7b1b88-d3f8-48ff-a730-80af0fd52351",
"CustomerGroupUUID": "1b89e133-222b-4cf1-849f-75ae187ef07b",
"CustomerUUID": "fad7f368-cbf2-4d6f-af8a-b8abcef520eb",
"ProjectUUID": "a70c8333-55a5-48b8-8c34-b16d0f6e718c",
"CampaignUUID": "a96114a4-861e-4b58-b27e-d769b0fe98c6",
"ItemUUID": "b4b48d67-b057-44d0-8f64-69a47e98cc41",
"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-02-04T04:13:23.8764615+01:00",
"ValidTo": "2026-02-04T04:13:23.8764615+01:00",
"CreatedAt": "2026-02-04T04:13:23.8764615+01:00",
"CreatedByUUID": "sample string 8",
"UpdatedAt": "2026-02-04T04:13:23.8764615+01:00",
"UpdatedByUUID": "sample string 9",
"DeletedAt": "2026-02-04T04:13:23.8764615+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": "5319043d-1f7b-40ad-9ef5-849f0b657594",
"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": "4e291b33-96a2-46bd-b20b-7497b0a226eb",
"PurchasePrice": 3.0,
"Price": 4.0,
"OutletId": "b026a481-39c2-4013-9ddd-3f52757bb2b8",
"PriceMode": 0,
"Updated": "2026-02-04T04:13:23.8764615+01:00"
},
{
"$ref": "8"
}
],
"Ingredients": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"Variants": [
{
"$id": "9",
"Id": 1,
"ConfigurationId": "90107aca-34f6-45bb-9c78-3d5d7f31a005",
"ItemId": "9b64c205-ee6d-4206-becb-1d165e43a25c",
"SortOrder": 4,
"Deleted": true,
"Updated": "2026-02-04T04:13:23.8764615+01:00"
},
{
"$ref": "9"
}
],
"ItemOption": [
{
"$id": "10",
"Id": "603bc08c-3422-4cdd-a1d4-d724bdabe634",
"ItemOptionGroupId": "37a74c6c-2e33-420f-915f-1f34cf6947f9",
"ItemId": "f7064033-06b4-4beb-861a-0cc1eb0893aa",
"CategoryId": 4,
"Active": true,
"Updated": "2026-02-04T04:13:23.8764615+01:00"
},
{
"$ref": "10"
}
],
"ShowOnReceipt": true,
"QuickAdd": true,
"HasIngredients": true,
"HasVariants": true,
"HasOptions": true,
"CategoryItemGroups": [
{
"$id": "11",
"Id": "ffcacf0c-fe76-4868-82a2-e1422089e6fd",
"CategoryId": 2,
"GroupId": "36198723-619c-4c6e-ac0d-b44ca33347f0",
"Qty": 4.0,
"Price": 5.0,
"Deleted": true,
"SortOrder": 7,
"Updated": "2026-02-04T04:13:23.8764615+01:00",
"Description": "sample string 9"
},
{
"$ref": "11"
}
],
"ItemPricePolicies": [
{
"$id": "12",
"Id": 1,
"ItemId": "ab36bce0-38cc-4001-8761-e0f33cb570c4",
"BuyLimit": 3,
"DiscountAmount": 4.0,
"Active": true,
"Deleted": true,
"Updated": "2026-02-04T04:13:23.8764615+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-02-04T04:13:23.8764615+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": "6aacdaae-dbb2-4e6d-ae07-e010fe19e6da",
"CategoryName": "sample string 85",
"ShowCategoryName": true,
"DiscountedPrice": 86.0,
"Qty": 87.0,
"ConfigurationId": 88,
"ItemOptionId": "cd35a6f0-0aa4-4722-8c62-f161d20740cb",
"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": "ed741138-060e-4986-a1ea-b74bcbf4f740",
"ParentUUID": "bb030e67-ce8a-4316-9144-66619f90700c",
"EntityUUID": "25c7e5ec-55ce-4bcb-a9b7-36eea873bcbc",
"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-02-04T04:13:23.8764615+01:00",
"UpdatedAt": "2026-02-04T04:13:23.8764615+01:00",
"UpdatedByUUID": "sample string 15",
"DeletedByUUID": "sample string 16",
"DeletedAt": "2026-02-04T04:13:23.8764615+01:00",
"Synced": true
},
{
"$ref": "14"
}
],
"HasFile": true,
"ItemAdditionalIdentifications": [
{
"$id": "15",
"UUID": "c4b0c239-3bab-4b35-af60-951f2349dfa6",
"ItemUUID": "920a5c49-bbae-441d-8d32-7f065c6ed026",
"ItemInstanceUUID": "sample string 3",
"Identifier": "sample string 4",
"IdentifierSchemeId": "sample string 5",
"CreatedAt": "2026-02-04T04:13:23.8764615+01:00",
"CreatedByUUID": "sample string 7",
"UpdatedAt": "2026-02-04T04:13:23.8764615+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.