Product (Create)

Creates a new Product.

Authentication

Every request needs both of the following:

An authorized UserID, passed in to the request body — this is the user's cieTrade.net email.
A Bearer Token in the Authorization header of your tool or code call. The token is found under Settings → Integration → Api Token.

The user must have Can Access cieTrade API checked under Settings → Users & Roles, and must have an email address on their user record — the create and update endpoints record that user against every change they make.

Request Example

POST https://api.cietrade.net/CreateProduct

{
  "UserID": "example@email.net",
  "ProductName": "HDPE Natural Regrind",
  "ProductReference": "HDPE-NAT-RG",
  "SKU": "PL-10045",
  "ProductCategory": "PLASTICS",
  "ProductGroup": "HDPE",
  "SalesAcct": "Sales - Plastics",
  "PurchAcct": "Purchases - Plastics",
  "UOMType": "WEIGHT",
  "InventoryType": "BULK PERPETUAL",
  "CommodityDesc": "High density polyethylene, natural, regrind.",
  "UseAsWasteGrade": false,
  "ShowCommDescOnDocs": true,
  "WhProductType": "INPUT",
  "ReportProductType": "PLASTICS",
  "UDF1": "Baled",
  "UDF2": "",
  "UDF3": "",
  "ScrapAutomobileGrade": false,
  "GSMFactor": 0
}

Body Parameters

Parameter	Description	Required
`UserID`	cieTrade.NET User Email. Used for Authentication and Logging.	REQUIRED
`ProductName`	Product name. Must be unique — the request is rejected if a Product with this name already exists in cieTrade.	REQUIRED
`ProductReference`	Product reference code.	OPTIONAL
`SKU`	SKU/Product Code	OPTIONAL
`ProductCategory`	Product category. Must match a Product Category in cieTrade. Required when `ProductGroup` is provided. See Product Category and Group section below.	OPTIONAL
`ProductGroup`	Product group. Must match a Product Group within the given `ProductCategory`. See Product Category and Group section below.	OPTIONAL
`SalesAcct`	Sales GL account name. See GL Accounts section below.	REQUIRED
`PurchAcct`	Purchase GL account name. See GL Accounts section below.	REQUIRED
`UOMType`	Unit of Measurement type. Defaults to `WEIGHT`. Accepts `WEIGHT`, `EACH`.	OPTIONAL
`InventoryType`	Inventory tracking model. Accepts `SERIAL`, `BULK NON PERPETUAL`, `BULK PERPETUAL`, `DO NOT TRACK`.	REQUIRED
`CommodityDesc`	Commodity description.	OPTIONAL
`UseAsWasteGrade`	Marks the product as a waste grade. Accepts `true`, `false`. Defaults to `false`.	OPTIONAL
`ShowCommDescOnDocs`	Shows the commodity description on documents. Accepts `true`, `false`. Defaults to `false`.	OPTIONAL
`WhProductType`	Warehouse product type. Accepts `INPUT`, `OUTPUT`.	OPTIONAL
`ReportProductType`	Report product type. Accepts `WASTE`, `RECYCLE`, `LANDFILL`, `PLASTICS`, `PAPER`, `METALS`, `WOOD`, `ORGANICS`, `ELECTRONIC SCRAP`, `NON LANDFILL`.	OPTIONAL
`UDF1`	User-defined field 1.	OPTIONAL
`UDF2`	User-defined field 2.	OPTIONAL
`UDF3`	User-defined field 3.	OPTIONAL
`ScrapAutomobileGrade`	Marks the product as a scrap automobile grade. Accepts `true`, `false`. Defaults to `false`.	OPTIONAL
`GSMFactor`	GSM conversion factor. Defaults to 0.	OPTIONAL

GL Accounts

SalesAcct and PurchAcct must match the name of an active GL Account in cieTrade.
SalesAcct must be an account in the Sales category. PurchAcct must be an account in the Purchases, Freight or Commission Expense category.

Response Example

On Success [HTTP 201]:

{
    "Msg": "Successfully Created Product HDPE Natural Regrind"
}

On Error [HTTP 500/HTTP 401/HTTP 400]:

{
    "ErrMsg": "Invalid UOM Type: BOX. Accepts WEIGHT or EACH."
}