POST api/Product/PostProduct

Post Product added at NIMPOS side

Request Information

URI Parameters

None.

Body Parameters

Product Model

Name	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

Sample:

{
  "Id": "d02438e8-eaca-4d9f-8f6d-5cac7a3eb74c",
  "Name": "sample string 2",
  "SKU": "sample string 3",
  "BarCode": "sample string 4",
  "PLU": "sample string 5",
  "GroupId": "9fb09160-faa9-423b-a2d5-9e81d46f1ad2",
  "SupplierId": "e47f3357-b66a-4fb1-aeea-76eed11e63eb",
  "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-04-04T05:16:48.7908866+02:00",
  "Updated": "2025-04-04T05:16:48.7908866+02:00",
  "UpdatedBy": "5ddacc30-cc22-4a8b-a2c3-ea256cf245b5",
  "CategoryId": 60,
  "Campaign": {
    "$id": "2",
    "Id": "f6a5345b-78d6-4a6b-b638-9a8406990167",
    "CampaignType": 0,
    "DiscountBy": 0,
    "BuyLimit": 2,
    "FreeOffer": 3,
    "Price": 4.0,
    "DiscountQtyIncrement": 5,
    "Description": "sample string 6",
    "StartDate": "2025-04-04T05:16:48.7908866+02:00",
    "EndDate": "2025-04-04T05:16:48.7908866+02:00",
    "Deleted": true,
    "Updated": "2025-04-04T05:16:48.7908866+02:00",
    "CampaignPriceDetails": [
      {
        "$id": "3",
        "Id": "19a631a1-b355-4c4b-93ab-d9fdbeae6496",
        "CampaignId": "3c82468d-e9f4-4278-8b61-684d5018f9fd",
        "Quantity": 3,
        "PayPrice": 4.0,
        "Deleted": true,
        "Updated": "2025-04-04T05:16:48.7908866+02:00"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "ItemsTags": [
    {
      "$id": "4",
      "Id": "b81936b5-1d06-46f8-b8a4-87f048cd0ba8",
      "TagId": "19b434b7-be87-48d4-9a25-6618fa204286",
      "ItemId": "9f000769-8272-43b6-96ab-259805ea997a",
      "Deleted": true,
      "Synced": true,
      "Updated": "2025-04-04T05:16:48.7908866+02:00",
      "TagName": "sample string 7"
    },
    {
      "$ref": "4"
    }
  ],
  "ItemCampaign": {
    "$id": "5",
    "UUID": "85baa211-76cf-492b-98c2-fe8b17efcd8b",
    "CampaignTypeId": "OPEN",
    "Title": "sample string 2",
    "DiscountBy": 1,
    "FreeOffer": 1,
    "BuyLimit": 1,
    "StartDate": "2025-04-04T05:16:48.7908866+02:00",
    "EndDate": "2025-04-04T05:16:48.7908866+02:00",
    "PriceEach": 1.0,
    "PriceTotal": 1.0,
    "Grouped": true,
    "CurrencyCode": "sample string 6",
    "IncludesVat": true,
    "CreatedAt": "2025-04-04T05:16:48.7908866+02:00",
    "CreatedByUUID": "sample string 9",
    "UpdatedAt": "2025-04-04T05:16:48.7908866+02:00",
    "UpdatedByUUID": "sample string 10",
    "DeletedAt": "2025-04-04T05:16:48.7908866+02:00",
    "DeletedByUUID": "sample string 11",
    "Synced": true,
    "ItemPrices": [
      {
        "$id": "6",
        "UUID": "90ee33ea-ca21-4dcc-ac20-c567fa916064",
        "PriceListUUID": "d9d5b050-fb4b-494b-acd6-ebf5a09790b9",
        "ItemGroupUUID": "82d588be-b3ec-42f1-8673-711840b68cdc",
        "AgreementUUID": "cccbefd5-1dca-4539-842d-ebf95b8b0bf0",
        "CustomerGroupUUID": "88c88ff7-c388-4f17-a5a7-6803654f9b81",
        "CustomerUUID": "7f7780c4-06c0-4e58-b895-6093e3384acb",
        "ProjectUUID": "5afe83dd-74ec-45d8-8edf-0d6645b6072f",
        "CampaignUUID": "fbb618a3-3ea8-4b65-a16e-c3568d97259c",
        "ItemUUID": "1922a3e0-4e4f-43a1-9718-11c79bfb9243",
        "WildCardSKU": "sample string 4",
        "MinQty": 1.0,
        "MaxQty": 1.0,
        "Price": 1.0,
        "Percentage": 1.0,
        "Type": "sample string 5",
        "RegularPrice": true,
        "ValidFrom": "2025-04-04T05:16:48.7908866+02:00",
        "ValidTo": "2025-04-04T05:16:48.7908866+02:00",
        "CreatedAt": "2025-04-04T05:16:48.7908866+02:00",
        "CreatedByUUID": "sample string 8",
        "UpdatedAt": "2025-04-04T05:16:48.7908866+02:00",
        "UpdatedByUUID": "sample string 9",
        "DeletedAt": "2025-04-04T05:16:48.7908866+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": "84edbe6f-210c-4036-ae9b-3e919688e8c0",
      "CategoryId": 3,
      "SortOrder": 4,
      "IsPrimary": true
    },
    {
      "$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": "85e6e20b-011a-489f-bfbd-0888671de949",
      "PurchasePrice": 3.0,
      "Price": 4.0,
      "OutletId": "5f4974d5-b625-4e12-8dc7-0f3b64351939",
      "PriceMode": 0,
      "Updated": "2025-04-04T05:16:48.7908866+02:00"
    },
    {
      "$ref": "8"
    }
  ],
  "Ingredients": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "Variants": [
    {
      "$id": "9",
      "Id": 1,
      "ConfigurationId": "9bfb0c92-0f3a-4a0e-af77-c21a3800fed6",
      "ItemId": "fef2c6ef-6522-42fc-a1f1-fdb75fceb6c4",
      "SortOrder": 4,
      "Deleted": true,
      "Updated": "2025-04-04T05:16:48.7908866+02:00"
    },
    {
      "$ref": "9"
    }
  ],
  "ItemOption": [
    {
      "$id": "10",
      "Id": "d988cf21-e2ef-4e4a-9625-bbc844ddf32f",
      "ItemOptionGroupId": "8c25c8ac-4ea8-48fb-8412-6b876f4a613a",
      "ItemId": "3346e8f0-d56e-450e-bbe5-c10d3007427a",
      "CategoryId": 4,
      "Active": true,
      "Updated": "2025-04-04T05:16:48.7908866+02:00"
    },
    {
      "$ref": "10"
    }
  ],
  "ShowOnReceipt": true,
  "QuickAdd": true,
  "HasIngredients": true,
  "CategoryItemGroups": [
    {
      "$id": "11",
      "Id": "87c6c33d-e759-4965-8d21-2eb0d3da0fe0",
      "CategoryId": 2,
      "GroupId": "9e8adab4-c36c-4ef0-9ae7-fe14cb55d5b7",
      "Qty": 4.0,
      "Price": 5.0,
      "Deleted": true,
      "SortOrder": 7,
      "Updated": "2025-04-04T05:16:48.7908866+02:00",
      "Description": "sample string 9"
    },
    {
      "$ref": "11"
    }
  ],
  "ItemPricePolicies": [
    {
      "$id": "12",
      "Id": 1,
      "ItemId": "dbbfaa24-0a36-4488-a5d7-09c8b980b1a8",
      "BuyLimit": 3,
      "DiscountAmount": 4.0,
      "Active": true,
      "Deleted": true,
      "Updated": "2025-04-04T05:16:48.7908866+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-04-04T05:16:48.7908866+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": "0968f093-339d-47f2-80d6-576ea4462309",
  "CategoryName": "sample string 83",
  "ShowCategoryName": true,
  "DiscountedPrice": 84.0,
  "Qty": 85.0,
  "ConfigurationId": 86,
  "ItemOptionId": "9e6ec670-6f62-4da5-8359-ccdad44941f7",
  "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:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.