POST api/V3/Product/CreateMultiple

Adds multiple new products in the batch (Max 2000 records can be updated in one request)

Request Information

URI Parameters

None.

Body Parameters

List of new products to be created (Max 2000)

Collection of 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
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.
MRP	Maximum Retail Price of the Product just for indication	string	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	decimal number	None.
SuperUnitConversionFactor	Super Unit Conversion Factor for the Super Unit	decimal number	None.
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
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.

Request Formats

application/json, text/json

Sample:

[
  {
    "ProductDivision": "sample string 1",
    "Brand": "sample string 2",
    "Category": "sample string 3",
    "DisplayCategory": "sample string 4",
    "StandardUnit": "sample string 5",
    "SuperUnit": "sample string 6",
    "Name": "sample string 7",
    "VariantName": "sample string 8",
    "MRP": "sample string 9",
    "Price": 10.1,
    "Unit": "sample string 11",
    "LocalName": "sample string 12",
    "Image": "sample string 13",
    "StandardUnitConversionFactor": 1.1,
    "SuperUnitConversionFactor": 1.1,
    "DisplayOrder": 1,
    "PackagingType": "sample string 14",
    "IsPromoted": true,
    "Description": "sample string 15",
    "ProductERPId": "sample string 16",
    "Schemes": "sample string 17",
    "PackSize": "sample string 18",
    "Color": "sample string 19",
    "AlternateCategory": "sample string 20",
    "IsNewLaunch": true,
    "MBQ": 1,
    "ExpiryInDays": 1,
    "GSTCategory": "sample string 21"
  },
  {
    "ProductDivision": "sample string 1",
    "Brand": "sample string 2",
    "Category": "sample string 3",
    "DisplayCategory": "sample string 4",
    "StandardUnit": "sample string 5",
    "SuperUnit": "sample string 6",
    "Name": "sample string 7",
    "VariantName": "sample string 8",
    "MRP": "sample string 9",
    "Price": 10.1,
    "Unit": "sample string 11",
    "LocalName": "sample string 12",
    "Image": "sample string 13",
    "StandardUnitConversionFactor": 1.1,
    "SuperUnitConversionFactor": 1.1,
    "DisplayOrder": 1,
    "PackagingType": "sample string 14",
    "IsPromoted": true,
    "Description": "sample string 15",
    "ProductERPId": "sample string 16",
    "Schemes": "sample string 17",
    "PackSize": "sample string 18",
    "Color": "sample string 19",
    "AlternateCategory": "sample string 20",
    "IsNewLaunch": true,
    "MBQ": 1,
    "ExpiryInDays": 1,
    "GSTCategory": "sample string 21"
  }
]

application/xml, text/xml

Sample:

<ArrayOfProductAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <ProductAdd>
    <AlternateCategory>sample string 20</AlternateCategory>
    <Color>sample string 19</Color>
    <Description>sample string 15</Description>
    <DisplayOrder>1</DisplayOrder>
    <ExpiryInDays>1</ExpiryInDays>
    <GSTCategory>sample string 21</GSTCategory>
    <Image>sample string 13</Image>
    <IsNewLaunch>true</IsNewLaunch>
    <IsPromoted>true</IsPromoted>
    <LocalName>sample string 12</LocalName>
    <MBQ>1</MBQ>
    <MRP>sample string 9</MRP>
    <Name>sample string 7</Name>
    <PackSize>sample string 18</PackSize>
    <PackagingType>sample string 14</PackagingType>
    <Price>10.1</Price>
    <ProductERPId>sample string 16</ProductERPId>
    <Schemes>sample string 17</Schemes>
    <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor>
    <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor>
    <Unit>sample string 11</Unit>
    <VariantName>sample string 8</VariantName>
    <Brand>sample string 2</Brand>
    <Category>sample string 3</Category>
    <DisplayCategory>sample string 4</DisplayCategory>
    <ProductDivision>sample string 1</ProductDivision>
    <StandardUnit>sample string 5</StandardUnit>
    <SuperUnit>sample string 6</SuperUnit>
  </ProductAdd>
  <ProductAdd>
    <AlternateCategory>sample string 20</AlternateCategory>
    <Color>sample string 19</Color>
    <Description>sample string 15</Description>
    <DisplayOrder>1</DisplayOrder>
    <ExpiryInDays>1</ExpiryInDays>
    <GSTCategory>sample string 21</GSTCategory>
    <Image>sample string 13</Image>
    <IsNewLaunch>true</IsNewLaunch>
    <IsPromoted>true</IsPromoted>
    <LocalName>sample string 12</LocalName>
    <MBQ>1</MBQ>
    <MRP>sample string 9</MRP>
    <Name>sample string 7</Name>
    <PackSize>sample string 18</PackSize>
    <PackagingType>sample string 14</PackagingType>
    <Price>10.1</Price>
    <ProductERPId>sample string 16</ProductERPId>
    <Schemes>sample string 17</Schemes>
    <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor>
    <SuperUnitConversionFactor>1.1</SuperUnitConversionFactor>
    <Unit>sample string 11</Unit>
    <VariantName>sample string 8</VariantName>
    <Brand>sample string 2</Brand>
    <Category>sample string 3</Category>
    <DisplayCategory>sample string 4</DisplayCategory>
    <ProductDivision>sample string 1</ProductDivision>
    <StandardUnit>sample string 5</StandardUnit>
    <SuperUnit>sample string 6</SuperUnit>
  </ProductAdd>
</ArrayOfProductAdd>

Response Information

Resource Description

Response Description with message and GUID or, ErrorMessage as String

ApiResponse

Name	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

Sample:

{
  "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

Sample:

<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>

POST api/V3/Product/CreateMultiple

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body