POST api/V3/Product/Create
Creates a new product. Method fails if a product of same name exists in the same category.
Request Information
URI Parameters
None.
Body Parameters
New product to be created
V3.ProductAdd| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductDivision |
Division of the Product |
string |
Required String length: inclusive between 0 and 100 |
| Brand |
Brand of the Product |
string |
Required String length: inclusive between 0 and 100 |
| Category |
Category Name of the Product |
string |
Required String length: inclusive between 0 and 100 |
| DisplayCategory |
Category of Display |
string |
String length: inclusive between 0 and 30 |
| StandardUnit | string |
String length: inclusive between 0 and 50 |
|
| SuperUnit |
Name of the Super Unit for the Product |
string |
String length: inclusive between 0 and 50 |
| P1 |
Additional string P1 |
string |
None. |
| P2 |
Additional string P2 |
string |
None. |
| P3 |
Additional string P3 |
string |
None. |
| P4 |
Additional string P4 |
string |
None. |
| P5 |
Additional string P5 |
string |
None. |
| Category2 |
Additional Category |
string |
None. |
| ProductVisibilityTag |
Visibility Tag for the Product |
VisibilityTag |
None. |
| PTRT |
PTR(T) |
decimal number |
None. |
| Name |
Name of the Product of the SKU |
string |
Required String length: inclusive between 0 and 100 |
| VariantName |
Name of the Variant of the SKU |
string |
None. |
| Display_MRP |
Maximum Retail Price of the Product just for indication |
string |
None. |
| MRP |
Maximum Retail Price of the Product for actual usage |
decimal number |
None. |
| Price |
Price to Retailer also kown as PTR |
decimal number |
None. |
| Unit |
Unit of Measurement for the product. e.g. 'box' or 'pcs' |
string |
Required String length: inclusive between 0 and 50 |
| LocalName |
Local Name of the Product |
string |
String length: inclusive between 0 and 100 |
| Image |
Not available in APIs |
string |
None. |
| StandardUnitConversionFactor |
Standard Unit Conversion Factor for the Standard Unit. Should be greater than 0. |
decimal number |
Range: inclusive between 4.94065645841247E-324 and 1.79769313486232E+308 |
| SuperUnitConversionFactor |
Super Unit Conversion Factor for the Super Unit. Should be greater than 0. |
decimal number |
Range: inclusive between 4.94065645841247E-324 and 1.79769313486232E+308 |
| DisplayOrder |
Order Position at which the Product is displayed in App |
integer |
None. |
| PackagingType |
Type of Packaging paper/Box/Pouch etc... |
string |
String length: inclusive between 0 and 20 |
| Channel |
Name of Channels |
string |
Not Mandatory |
| IsPromoted |
True or False indicating if the product is a Promoted Product |
boolean |
None. |
| Description |
Brief Description if needed... |
string |
None. |
| ProductERPId |
SAP or ERP id of the product |
string |
Required String length: inclusive between 1 and 50 |
| Schemes |
Scheme details for the product |
string |
None. |
| PackSize |
Pack Size of the Product |
string |
None. |
| Color |
Color of the Product |
string |
String length: inclusive between 0 and 64 |
| AlternateCategory |
Alternate Category of the Product |
string |
None. |
| IsNewLaunch |
IsNewProduct as True or False |
boolean |
None. |
| MBQ |
Minimum Batch Quantity |
integer |
Range: inclusive between 1 and 2147483647 |
| ExpiryInDays |
Expiry in days of the product |
integer |
None. |
| GSTCategory |
Category for Tax at Sale Point |
string |
None. |
| ShortName |
Short name of the Product |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| HSNCode |
HSN Code of the Product |
integer |
Range: inclusive between 0 and 99999999 |
| HSNCodeStr | string |
None. |
|
| ShelfLifeInDays |
Shelf life in days of the Product |
integer |
Not Mandatory |
| Barcode |
Barcode of the Product |
string |
Not Mandatory |
| NetWeight |
Net weight of the Product (in GM) |
decimal number |
None. |
| GrossWeight |
Gross weight of the Product (in GM) |
decimal number |
Not Mandatory |
| PTRMT |
PTD for Super Stockist of the Product |
decimal number |
Not Mandatory |
| PTDSuper |
PTD for Super Stockist of the Product |
decimal number |
Not Mandatory |
| PTDSub |
PTD for Sub Stockist of the Product |
decimal number |
Not Mandatory |
| PTD |
PTD for Distributor of the Product |
decimal number |
Not Mandatory |
| AttributeText1 |
Additional Attribute of Product |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| AttributeText2 |
Additional Attribute of Product |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| AttributeBoolean1 |
Additional Attribute of Product |
boolean |
Not Mandatory |
| AttributeBoolean2 |
Additional Attribute of Product |
boolean |
Not Mandatory |
| AttributeNumber1 |
Additional Attribute of Product |
decimal number |
Not Mandatory Range: inclusive between -1E+50 and 1E+50 |
| AttributeNumber2 |
Additional Attribute of Product |
decimal number |
Not Mandatory Range: inclusive between -1E+50 and 1E+50 |
| AttributeDate1 |
Additional Attribute of Product |
date |
Not Mandatory |
| AttributeDate2 |
Additional Attribute of Product |
date |
Not Mandatory |
| PTRDelta |
Delta of PTR |
decimal number |
None. |
| IsSaleable |
Is Saleable |
boolean |
None. |
| EpochTime |
Epoch Time of Last Updation Timestamp of the product |
integer |
None. |
| LastUpdatedAt |
Last Updation Date time of the product |
date |
None. |
| AdditionalUnit |
AdditionalUnit of the product |
string |
None. |
| AdditionalUnitConversionFactor |
AdditionalUnitConversionFactor of the product |
decimal number |
None. |
Request Formats
application/json, text/json
{
"ProductDivision": "sample string 1",
"Brand": "sample string 2",
"Category": "sample string 3",
"DisplayCategory": "sample string 4",
"StandardUnit": "sample string 5",
"SuperUnit": "sample string 6",
"P1": "sample string 7",
"P2": "sample string 8",
"P3": "sample string 9",
"P4": "sample string 10",
"P5": "sample string 11",
"Category2": "sample string 12",
"ProductVisibilityTag": "General",
"PTRT": 1.0,
"Name": "sample string 13",
"VariantName": "sample string 14",
"Display_MRP": "sample string 15",
"MRP": 1.0,
"Price": 1.1,
"Unit": "sample string 16",
"LocalName": "sample string 17",
"Image": "sample string 18",
"StandardUnitConversionFactor": 1.1,
"SuperUnitConversionFactor": 1.1,
"DisplayOrder": 1,
"PackagingType": "sample string 19",
"Channel": "sample string 20",
"IsPromoted": true,
"Description": "sample string 21",
"ProductERPId": "sample string 22",
"Schemes": "sample string 23",
"PackSize": "sample string 24",
"Color": "sample string 25",
"AlternateCategory": "sample string 26",
"IsNewLaunch": true,
"MBQ": 1,
"ExpiryInDays": 1,
"GSTCategory": "sample string 27",
"ShortName": "sample string 28",
"HSNCode": 1,
"HSNCodeStr": "sample string 29",
"ShelfLifeInDays": 1,
"Barcode": "sample string 30",
"NetWeight": 1.0,
"GrossWeight": 1.0,
"PTRMT": 1.0,
"PTDSuper": 1.0,
"PTDSub": 1.0,
"PTD": 1.0,
"AttributeText1": "sample string 31",
"AttributeText2": "sample string 32",
"AttributeBoolean1": true,
"AttributeBoolean2": true,
"AttributeNumber1": 1.1,
"AttributeNumber2": 1.1,
"AttributeDate1": "2025-04-04T04:59:53.5629825+00:00",
"AttributeDate2": "2025-04-04T04:59:53.5629825+00:00",
"PTRDelta": 1.1,
"IsSaleable": true,
"EpochTime": 1,
"LastUpdatedAt": "2025-04-04T04:59:53.5629825+00:00",
"AdditionalUnit": "sample string 35",
"AdditionalUnitConversionFactor": 1.1
}
application/xml, text/xml
<ProductAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models"> <AdditionalUnit>sample string 35</AdditionalUnit> <AdditionalUnitConversionFactor>1.1</AdditionalUnitConversionFactor> <AlternateCategory>sample string 26</AlternateCategory> <AttributeBoolean1>true</AttributeBoolean1> <AttributeBoolean2>true</AttributeBoolean2> <AttributeDate1>2025-04-04T04:59:53.5629825+00:00</AttributeDate1> <AttributeDate2>2025-04-04T04:59:53.5629825+00:00</AttributeDate2> <AttributeNumber1>1.1</AttributeNumber1> <AttributeNumber2>1.1</AttributeNumber2> <AttributeText1>sample string 31</AttributeText1> <AttributeText2>sample string 32</AttributeText2> <Barcode>sample string 30</Barcode> <Channel>sample string 20</Channel> <Color>sample string 25</Color> <Description>sample string 21</Description> <DisplayOrder>1</DisplayOrder> <Display_MRP>sample string 15</Display_MRP> <EpochTime>1</EpochTime> <ExpiryInDays>1</ExpiryInDays> <GSTCategory>sample string 27</GSTCategory> <GrossWeight>1</GrossWeight> <HSNCode>1</HSNCode> <HSNCodeStr>sample string 29</HSNCodeStr> <Image>sample string 18</Image> <IsNewLaunch>true</IsNewLaunch> <IsPromoted>true</IsPromoted> <IsSaleable>true</IsSaleable> <LastUpdatedAt>2025-04-04T04:59:53.5629825+00:00</LastUpdatedAt> <LocalName>sample string 17</LocalName> <MBQ>1</MBQ> <MRP>1</MRP> <Name>sample string 13</Name> <NetWeight>1</NetWeight> <PTD>1</PTD> <PTDSub>1</PTDSub> <PTDSuper>1</PTDSuper> <PTRDelta>1.1</PTRDelta> <PTRMT>1</PTRMT> <PackSize>sample string 24</PackSize> <PackagingType>sample string 19</PackagingType> <Price>1.1</Price> <ProductERPId>sample string 22</ProductERPId> <Schemes>sample string 23</Schemes> <ShelfLifeInDays>1</ShelfLifeInDays> <ShortName>sample string 28</ShortName> <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor> <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor> <Unit>sample string 16</Unit> <VariantName>sample string 14</VariantName> <Brand>sample string 2</Brand> <Category>sample string 3</Category> <Category2>sample string 12</Category2> <DisplayCategory>sample string 4</DisplayCategory> <P1>sample string 7</P1> <P2>sample string 8</P2> <P3>sample string 9</P3> <P4>sample string 10</P4> <P5>sample string 11</P5> <PTRT>1</PTRT> <ProductDivision>sample string 1</ProductDivision> <StandardUnit>sample string 5</StandardUnit> <SuperUnit>sample string 6</SuperUnit> <VisibilityTag>General</VisibilityTag> </ProductAdd>
Response Information
Resource Description
Response object with Guid and message or an Error Message
ApiResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| ERPId |
ERPID of the Requested insertion/updation |
string |
None. |
| Message |
Error Message for the indicated ERPID |
string |
None. |
| ResponseStatus |
Status of the action requested from Api |
ResponseStatus |
None. |
| GUID |
GUID of the database Entry with respect to the ERP Id Provided |
string |
None. |
Response Formats
application/json, text/json
{
"ERPId": "sample string 1",
"Message": "sample string 2",
"ResponseStatus": "Failure",
"GUID": "sample string 3"
}
application/xml, text/xml
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common"> <ERPId>sample string 1</ERPId> <GUID>sample string 3</GUID> <Message>sample string 2</Message> <ResponseStatus>Failure</ResponseStatus> </ApiResponseMessage>