POST api/V3/Product/CreateUpdateMultipleAsync
This API is used to create or update multiple products (maximum limit of 100 at once in input)
Request Information
URI Parameters
None.
Body Parameters
Collection of V3.ProductCreateUpdateName | Description | Type | Additional information |
---|---|---|---|
ProductDivision |
Division of the Product (creation field) |
string |
String length: inclusive between 0 and 100 |
ProductDivisionERPId |
Division of the Product (creation field) |
string |
String length: inclusive between 0 and 100 |
Brand |
Brand of the Product (creation field) |
string |
String length: inclusive between 0 and 100 |
BrandERPId |
Brand of the Product (creation field) |
string |
String length: inclusive between 0 and 100 |
Category |
Category Name of the Product (creation field) |
string |
String length: inclusive between 0 and 100 |
CategoryERPId |
Category Name of the Product (creation field) |
string |
String length: inclusive between 0 and 100 |
DisplayCategory |
Category of Display (creation field) |
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 (creation field) |
string |
String length: inclusive between 0 and 50 |
Deactivated |
Product is disabled (updation field) |
boolean |
None. |
ProductGuid |
Guid of the product (updation field. used to fetch existing product. alternatively can use productERPId) |
string |
None. |
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. |
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", "ProductDivisionERPId": "sample string 2", "Brand": "sample string 3", "BrandERPId": "sample string 4", "Category": "sample string 5", "CategoryERPId": "sample string 6", "DisplayCategory": "sample string 7", "StandardUnit": "sample string 8", "SuperUnit": "sample string 9", "Deactivated": true, "ProductGuid": "sample string 10", "P1": "sample string 11", "P2": "sample string 12", "P3": "sample string 13", "P4": "sample string 14", "P5": "sample string 15", "Category2": "sample string 16", "Name": "sample string 17", "VariantName": "sample string 18", "Display_MRP": "sample string 19", "MRP": 1.0, "Price": 1.1, "Unit": "sample string 20", "LocalName": "sample string 21", "Image": "sample string 22", "StandardUnitConversionFactor": 1.1, "SuperUnitConversionFactor": 1.1, "DisplayOrder": 1, "PackagingType": "sample string 23", "Channel": "sample string 24", "IsPromoted": true, "Description": "sample string 25", "ProductERPId": "sample string 26", "Schemes": "sample string 27", "PackSize": "sample string 28", "Color": "sample string 29", "AlternateCategory": "sample string 30", "IsNewLaunch": true, "MBQ": 1, "ExpiryInDays": 1, "GSTCategory": "sample string 31", "ShortName": "sample string 32", "HSNCode": 1, "HSNCodeStr": "sample string 33", "ShelfLifeInDays": 1, "Barcode": "sample string 34", "NetWeight": 1.0, "GrossWeight": 1.0, "PTRMT": 1.0, "PTDSuper": 1.0, "PTDSub": 1.0, "PTD": 1.0, "AttributeText1": "sample string 35", "AttributeText2": "sample string 36", "AttributeBoolean1": true, "AttributeBoolean2": true, "AttributeNumber1": 1.1, "AttributeNumber2": 1.1, "AttributeDate1": "2025-04-04T05:21:17.5933686+00:00", "AttributeDate2": "2025-04-04T05:21:17.5933686+00:00", "PTRDelta": 1.1, "IsSaleable": true, "EpochTime": 1, "LastUpdatedAt": "2025-04-04T05:21:17.5933686+00:00", "AdditionalUnit": "sample string 39", "AdditionalUnitConversionFactor": 1.1 }, { "ProductDivision": "sample string 1", "ProductDivisionERPId": "sample string 2", "Brand": "sample string 3", "BrandERPId": "sample string 4", "Category": "sample string 5", "CategoryERPId": "sample string 6", "DisplayCategory": "sample string 7", "StandardUnit": "sample string 8", "SuperUnit": "sample string 9", "Deactivated": true, "ProductGuid": "sample string 10", "P1": "sample string 11", "P2": "sample string 12", "P3": "sample string 13", "P4": "sample string 14", "P5": "sample string 15", "Category2": "sample string 16", "Name": "sample string 17", "VariantName": "sample string 18", "Display_MRP": "sample string 19", "MRP": 1.0, "Price": 1.1, "Unit": "sample string 20", "LocalName": "sample string 21", "Image": "sample string 22", "StandardUnitConversionFactor": 1.1, "SuperUnitConversionFactor": 1.1, "DisplayOrder": 1, "PackagingType": "sample string 23", "Channel": "sample string 24", "IsPromoted": true, "Description": "sample string 25", "ProductERPId": "sample string 26", "Schemes": "sample string 27", "PackSize": "sample string 28", "Color": "sample string 29", "AlternateCategory": "sample string 30", "IsNewLaunch": true, "MBQ": 1, "ExpiryInDays": 1, "GSTCategory": "sample string 31", "ShortName": "sample string 32", "HSNCode": 1, "HSNCodeStr": "sample string 33", "ShelfLifeInDays": 1, "Barcode": "sample string 34", "NetWeight": 1.0, "GrossWeight": 1.0, "PTRMT": 1.0, "PTDSuper": 1.0, "PTDSub": 1.0, "PTD": 1.0, "AttributeText1": "sample string 35", "AttributeText2": "sample string 36", "AttributeBoolean1": true, "AttributeBoolean2": true, "AttributeNumber1": 1.1, "AttributeNumber2": 1.1, "AttributeDate1": "2025-04-04T05:21:17.5933686+00:00", "AttributeDate2": "2025-04-04T05:21:17.5933686+00:00", "PTRDelta": 1.1, "IsSaleable": true, "EpochTime": 1, "LastUpdatedAt": "2025-04-04T05:21:17.5933686+00:00", "AdditionalUnit": "sample string 39", "AdditionalUnitConversionFactor": 1.1 } ]
application/xml, text/xml
<ArrayOfProductCreateUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models"> <ProductCreateUpdate> <AdditionalUnit>sample string 39</AdditionalUnit> <AdditionalUnitConversionFactor>1.1</AdditionalUnitConversionFactor> <AlternateCategory>sample string 30</AlternateCategory> <AttributeBoolean1>true</AttributeBoolean1> <AttributeBoolean2>true</AttributeBoolean2> <AttributeDate1>2025-04-04T05:21:17.5933686+00:00</AttributeDate1> <AttributeDate2>2025-04-04T05:21:17.5933686+00:00</AttributeDate2> <AttributeNumber1>1.1</AttributeNumber1> <AttributeNumber2>1.1</AttributeNumber2> <AttributeText1>sample string 35</AttributeText1> <AttributeText2>sample string 36</AttributeText2> <Barcode>sample string 34</Barcode> <Channel>sample string 24</Channel> <Color>sample string 29</Color> <Description>sample string 25</Description> <DisplayOrder>1</DisplayOrder> <Display_MRP>sample string 19</Display_MRP> <EpochTime>1</EpochTime> <ExpiryInDays>1</ExpiryInDays> <GSTCategory>sample string 31</GSTCategory> <GrossWeight>1</GrossWeight> <HSNCode>1</HSNCode> <HSNCodeStr>sample string 33</HSNCodeStr> <Image>sample string 22</Image> <IsNewLaunch>true</IsNewLaunch> <IsPromoted>true</IsPromoted> <IsSaleable>true</IsSaleable> <LastUpdatedAt>2025-04-04T05:21:17.5933686+00:00</LastUpdatedAt> <LocalName>sample string 21</LocalName> <MBQ>1</MBQ> <MRP>1</MRP> <Name>sample string 17</Name> <NetWeight>1</NetWeight> <PTD>1</PTD> <PTDSub>1</PTDSub> <PTDSuper>1</PTDSuper> <PTRDelta>1.1</PTRDelta> <PTRMT>1</PTRMT> <PackSize>sample string 28</PackSize> <PackagingType>sample string 23</PackagingType> <Price>1.1</Price> <ProductERPId>sample string 26</ProductERPId> <Schemes>sample string 27</Schemes> <ShelfLifeInDays>1</ShelfLifeInDays> <ShortName>sample string 32</ShortName> <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor> <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor> <Unit>sample string 20</Unit> <VariantName>sample string 18</VariantName> <Brand>sample string 3</Brand> <BrandERPId>sample string 4</BrandERPId> <Category>sample string 5</Category> <Category2>sample string 16</Category2> <CategoryERPId>sample string 6</CategoryERPId> <Deactivated>true</Deactivated> <DisplayCategory>sample string 7</DisplayCategory> <P1>sample string 11</P1> <P2>sample string 12</P2> <P3>sample string 13</P3> <P4>sample string 14</P4> <P5>sample string 15</P5> <ProductDivision>sample string 1</ProductDivision> <ProductDivisionERPId>sample string 2</ProductDivisionERPId> <ProductGuid>sample string 10</ProductGuid> <StandardUnit>sample string 8</StandardUnit> <SuperUnit>sample string 9</SuperUnit> </ProductCreateUpdate> <ProductCreateUpdate> <AdditionalUnit>sample string 39</AdditionalUnit> <AdditionalUnitConversionFactor>1.1</AdditionalUnitConversionFactor> <AlternateCategory>sample string 30</AlternateCategory> <AttributeBoolean1>true</AttributeBoolean1> <AttributeBoolean2>true</AttributeBoolean2> <AttributeDate1>2025-04-04T05:21:17.5933686+00:00</AttributeDate1> <AttributeDate2>2025-04-04T05:21:17.5933686+00:00</AttributeDate2> <AttributeNumber1>1.1</AttributeNumber1> <AttributeNumber2>1.1</AttributeNumber2> <AttributeText1>sample string 35</AttributeText1> <AttributeText2>sample string 36</AttributeText2> <Barcode>sample string 34</Barcode> <Channel>sample string 24</Channel> <Color>sample string 29</Color> <Description>sample string 25</Description> <DisplayOrder>1</DisplayOrder> <Display_MRP>sample string 19</Display_MRP> <EpochTime>1</EpochTime> <ExpiryInDays>1</ExpiryInDays> <GSTCategory>sample string 31</GSTCategory> <GrossWeight>1</GrossWeight> <HSNCode>1</HSNCode> <HSNCodeStr>sample string 33</HSNCodeStr> <Image>sample string 22</Image> <IsNewLaunch>true</IsNewLaunch> <IsPromoted>true</IsPromoted> <IsSaleable>true</IsSaleable> <LastUpdatedAt>2025-04-04T05:21:17.5933686+00:00</LastUpdatedAt> <LocalName>sample string 21</LocalName> <MBQ>1</MBQ> <MRP>1</MRP> <Name>sample string 17</Name> <NetWeight>1</NetWeight> <PTD>1</PTD> <PTDSub>1</PTDSub> <PTDSuper>1</PTDSuper> <PTRDelta>1.1</PTRDelta> <PTRMT>1</PTRMT> <PackSize>sample string 28</PackSize> <PackagingType>sample string 23</PackagingType> <Price>1.1</Price> <ProductERPId>sample string 26</ProductERPId> <Schemes>sample string 27</Schemes> <ShelfLifeInDays>1</ShelfLifeInDays> <ShortName>sample string 32</ShortName> <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor> <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor> <Unit>sample string 20</Unit> <VariantName>sample string 18</VariantName> <Brand>sample string 3</Brand> <BrandERPId>sample string 4</BrandERPId> <Category>sample string 5</Category> <Category2>sample string 16</Category2> <CategoryERPId>sample string 6</CategoryERPId> <Deactivated>true</Deactivated> <DisplayCategory>sample string 7</DisplayCategory> <P1>sample string 11</P1> <P2>sample string 12</P2> <P3>sample string 13</P3> <P4>sample string 14</P4> <P5>sample string 15</P5> <ProductDivision>sample string 1</ProductDivision> <ProductDivisionERPId>sample string 2</ProductDivisionERPId> <ProductGuid>sample string 10</ProductGuid> <StandardUnit>sample string 8</StandardUnit> <SuperUnit>sample string 9</SuperUnit> </ProductCreateUpdate> </ArrayOfProductCreateUpdate>
Response Information
Resource Description
Response Description with message and GUID or, ErrorMessage as String
ApiResponseName | Description | Type | Additional information |
---|---|---|---|
Message |
Message Indicating the Overall Response Summary of the Requested API |
string |
None. |
ResponseList |
List of Errors |
Collection of ApiResponseMessage |
None. |
Response |
Enum Indicating the Response status |
ResponseStatus |
None. |
ResponseStatusCount |
Summary containing Number of SuccessFull And Failed Tasks |
ResponseStatusCount |
None. |
Response Formats
application/json, text/json
{ "Message": "sample string 1", "ResponseList": [ { "ERPId": "sample string 1", "Message": "sample string 2", "ResponseStatus": "Failure", "GUID": "sample string 3" }, { "ERPId": "sample string 1", "Message": "sample string 2", "ResponseStatus": "Failure", "GUID": "sample string 3" } ], "Response": "Failure", "ResponseStatusCount": { "Updated": 1, "Failed": 2, "Ignored": 3, "Name": "sample string 1", "Total": 6, "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3", "ResponseStatus": "PartialSuccess" } }
application/xml, text/xml
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common"> <Message>sample string 1</Message> <Response>Failure</Response> <ResponseList> <ApiResponseMessage> <ERPId>sample string 1</ERPId> <GUID>sample string 3</GUID> <Message>sample string 2</Message> <ResponseStatus>Failure</ResponseStatus> </ApiResponseMessage> <ApiResponseMessage> <ERPId>sample string 1</ERPId> <GUID>sample string 3</GUID> <Message>sample string 2</Message> <ResponseStatus>Failure</ResponseStatus> </ApiResponseMessage> </ResponseList> <ResponseStatusCount> <Failed>2</Failed> <Ignored>3</Ignored> <Name>sample string 1</Name> <Updated>1</Updated> </ResponseStatusCount> </ApiResponse>