The Products API allows for a great deal of flexibility and control over product creation. This document covers how to push products using REST API. Here below is the request JSON to push the product data.
| Field | Type | Compulsory | Description |
| StockId | String | Yes | This is the unique identifier for the product / bundle. |
| Sku | String | Yes | This is the unique identifier for the product / bundle. This could either be auto-generated by the system or can also be provided by you as well. |
| ProductName | String | Yes | Name of the product |
| ShortDescription | String | No | Short description of the product |
| LongDescription | String | No | Long description of the product |
| ItemType | String | Yes | This is product type that you are setting up example standard product, gift card, bundle, etc. |
| BrandName | String | Yes | This is brand or the manufacturer name of the product. |
| BrandId | string | No | This is the unique identifier for the brand. |
| SubBrandId | string | No | This is the unique identifier for the sub brand. |
| SubBrandName | string | No | This is sub brand or the sub manufacturer name of a product. |
| CategoryId | string | No | Units of measure - by default, its set to pc (pieces) |
| Category | String | Yes | This is the immediate category of the product. |
| ListPrice | String | No | This is the List price of the product, also commonly known as MRP (max retail price) or RRP (recommended retail price) |
| CostPrice | Decimal | No | Cost price of the product at which it was purchased and this can be left blank or 0 while import. The cost price is used to calculate the gross profit / gross margin for the sales. So, this should ideally be populated with the landing cost of the product. |
| SellPrice | Decimal | Yes | Sell price is the product at which it is going to be sell to the user. |
| CurrentStock | Numeric | No | This is available stock value of the product which can be 0 or greater. |
| Currency | Numeric | No | This is currency of the product. |
| Weight | String | No | Weight of the product. |
| Size | String | No | If a product having multiple size then this info can be uploaded with pipe symbol example in fashion industry one product can have multiple size M|S. Using this convention, the system will automatically create different variants for the products. |
| LengthMM | Numeric | No | This is length of the product in mm-one of the core attributes/dimensions of the product, if applicable. |
| WidthMM | Numeric | No | This is width of the product in mm-one of the core attributes/dimensions of the product, if applicable. |
| HeightMM | Numeric | No | This is height of the product in mm-one of the core attributes/dimensions of the product, if applicable. |
| Gender | String | No | This is a custom attribute for the product. |
| ColorText | String | No | This is the name of the color that is used for displaying on the PDP |
| ColorHex | String | No | This is the color hex code, eg #FFFFFF - white. This is used to display the color swatch on PDP / PLP and also used for color grouping |
| Image1 | String | No | Name of the primary image. This image would be setup as the default image. All these images can be bulk uploaded within the media library and the platform will automatically map them to the product based on the names provided |
| Image2 | String | No | Name of the additional image 2 |
| Image3 | String | No | Name of the additional image 3 |
| Image4 | String | No | Name of the additional image 4 |
| Image5 | String | No | Name of the additional image5 |
| Barcode | string | No | The barcode identifier for the product |
| UOM | string | No | Units of measure - by default, its set to pc (pieces) |
| IsTaxable | string | No | This signifies if this product is taxable or not |
| Gender | string | No | This is one of the core attributes that can be used to identify if a product is gender specific |
| CustomAttributes | string | No | This can take the values in the form of key-pair value and use to enrich the product data. For example: "key": "fabric", "value": "cotton" |
| Visible | Boolean | Yes | This value signifies if the product is visible on the site |
| Published | Boolean | Yes | This value signifies if the product is published and ready to be available on the site |