POST api/V3/Distributor/CreateWithPDs

Creates Distributor with Product Divsion Mappings

Request Information

URI Parameters

None.

Body Parameters

Distributors with PDs To be Added(Max 500)

Name	Description	Type	Additional information
SuperStockistName	SuperStockist of the distributor	string	String length: inclusive between 0 and 100
SuperStockistErpId	ErpId of the SuperStockist	string	String length: inclusive between 0 and 100
ProductDivisons	List of Product Divison names	Collection of string	Required
Id	Id of the distributor.	integer	None.
Name	Name of the distributor.	string	Required
ContactNo	Contact no.	string	None.
EmailId	Email Id	string	None.
SecondaryEmailId	Secondary EmailId Id	string	None.
Manager	Name of The contact Person	string	None.
DistributorERPId	ERP or SAP id for the distributor.	string	None.
LocalName	Alternate/Local for the distributor.	string	String length: inclusive between 0 and 100
Address	Address of the Location of the distributor	string	None.
City	City Name of the distributor.	string	None.
Place	Location/City of the distributor	string	String length: inclusive between 0 and 50
GSTIN	GSTIN (Goods and Service Tax Identity Number) No.	string	String length: inclusive between 15 and 15
TIN	TIN No.	string	String length: inclusive between 0 and 15
Pincode	Pincode of the Locationof the distributor	string	Data type: PostalCode String length: inclusive between 6 and 6
Region	Region of the distributor	string	Required
RegionERPId	Erp ID of the region	string	None.
Zone	Zone of the distributor	string	None.
ZoneErpId	Erp ID of the zone	string	None.
GeoLevel5Name	Level 5 geo in the hierarchy of the concerned zone	string	None.
GeoLevel5ErpId	Erp ID of the Level 5 geo	string	None.
GeoLevel6Name	Level 6 geo in the hierarchy of the concerned zone	string	None.
GeoLevel6ErpId	Erp ID of the Level 6 geo	string	None.
GeoLevel7Name	Level 7 geo in the hierarchy of the concerned zone	string	None.
GeoLevel7ErpId	Erp ID of the Level 7 geo	string	None.
IsDeactive	Set if Distributor is deactive.. (Only for Updating) This Data will be Ignored if used during Distributor Creation	boolean	None.
ParentERPId	ERP or SAP id for the Super stockist. This data is used while creating sub stockist and will be ignored while listing	string	None.
DistributorCategory	Reference from Company defined Category List	string	None.
DistributorGrade	Distributor grade should be valid Possible values are -1. Urban 2 Semi Urban 3. Metro 4. Non Metro 5. Rural.	string	None.
DistributorChannelErpId	Reference from Company defined Channel List Channel Erp Id of the distributor	string	None.
PANNumber	PAN Number of the distributor	string	String length: inclusive between 10 and 10
FSSAINumber	FSSAI Number of the distributor	string	String length: inclusive between 14 and 14
FSSAIExiryDate	FSSAI Expiry of the distributor	date	None.
BankName	Bank Name of the distributor	string	None.
BankAccountNumber	Bank Account Number of the distributor	string	None.
BankIFSCCode	Bank IFSC Code of the distributor	string	None.
AttributeText1	Additional attribute of the distributor	string	String length: inclusive between 0 and 50
AttributeText2	Additional attribute of the distributor	string	String length: inclusive between 0 and 50
AttributeText3	Additional attribute of the distributor	string	String length: inclusive between 0 and 50
AttributeBoolean1	Additional attribute of the distributor	boolean	None.
AttributeBoolean2	Additional attribute of the distributor	boolean	None.
AttributeNumber1	Additional attribute of the distributor	decimal number	None.
AttributeNumber2	Additional attribute of the distributor	decimal number	None.
AttributeDate1	Additional attribute of the distributor	date	None.
AttributeDate2	Additional attribute of the distributor	date	None.
StockistType	Distributor StockistType should be valid Possible values are 0. Unknown 1. Stockist 2. Super Stockist 3. Sub Stockist 4. Mega Stockist	string	None.
DistributorChannelIdErpId	Channel Erp Id of the distributor Channel	string	None.
DistributorSegmentationIdErpId	Segmentation Erp Id of the distributor Channel	string	None.
State	State of the distributor	string	String length: inclusive between 0 and 50
PlaceOfSupply	Place Of Supply	string	String length: inclusive between 0 and 1000
WarehouseId	Warehouse Id	string	None.
WarehouseState	Warehouse State	string	None.
WarehouseCity	Warehouse City	string	None.
WarehouseAddress	Warehouse Address	string	None.
WarehouseName	Warehouse Name	string	None.
WarehouseErpId	Warehouse ErpId	string	None.
SecurityDeposit	Distributor Security Deposit of the distributor	string	None.
DDNumber	Distributor DD Number of the distributor	string	None.
DateOfPayment	Distributor Date Of Payment of the distributor	date	None.
PaymentMode	Distributor Payment Mode of the distributor	string	None.
IsGSTRegistered	IsGST Registered Mode of the distributor	boolean	None.
IntransitPeriod	IntransitPeriod == Days of Transit in which the Shipment from the Seller reaches the DB	integer	Range: inclusive between 0 and 2147483647
CreditDuration	Credit Duration	integer	Range: inclusive between 0 and 2147483647
CreditValue	Credit Value	decimal number	Range: inclusive between 0 and 1.79769313486232E+308
CreditInvoiceCount	Credit Invoice Count	integer	Range: inclusive between 0 and 2147483647
Latitude	Latitude	decimal number	None.
Longitude	Longitude	decimal number	None.
Aadhar	Aadhar	string	None.
DOB	DOB	string	None.
OwnerName	OwnerName	string	None.
OwnerNo	OwnerNo	string	None.
CashDiscountLimit	CashDiscountLimit	decimal number	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "SuperStockistName": "sample string 1",
    "SuperStockistErpId": "sample string 2",
    "ProductDivisons": [
      "sample string 1",
      "sample string 2"
    ],
    "Id": 3,
    "Name": "sample string 4",
    "ContactNo": "sample string 5",
    "EmailId": "sample string 6",
    "SecondaryEmailId": "sample string 7",
    "Manager": "sample string 8",
    "DistributorERPId": "sample string 9",
    "LocalName": "sample string 10",
    "Address": "sample string 11",
    "City": "sample string 12",
    "Place": "sample string 13",
    "GSTIN": "sample string 14",
    "TIN": "sample string 15",
    "Pincode": "sample string 16",
    "Region": "sample string 17",
    "RegionERPId": "sample string 18",
    "Zone": "sample string 19",
    "ZoneErpId": "sample string 20",
    "GeoLevel5Name": "sample string 21",
    "GeoLevel5ErpId": "sample string 22",
    "GeoLevel6Name": "sample string 23",
    "GeoLevel6ErpId": "sample string 24",
    "GeoLevel7Name": "sample string 25",
    "GeoLevel7ErpId": "sample string 26",
    "IsDeactive": true,
    "ParentERPId": "sample string 27",
    "DistributorCategory": "sample string 28",
    "DistributorGrade": "sample string 29",
    "DistributorChannelErpId": "sample string 30",
    "PANNumber": "sample string 31",
    "FSSAINumber": "sample string 32",
    "FSSAIExiryDate": "2025-10-19T23:45:05.3657199+00:00",
    "BankName": "sample string 33",
    "BankAccountNumber": "sample string 34",
    "BankIFSCCode": "sample string 35",
    "AttributeText1": "sample string 36",
    "AttributeText2": "sample string 37",
    "AttributeText3": "sample string 38",
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeDate1": "2025-10-19T23:45:05.3657199+00:00",
    "AttributeDate2": "2025-10-19T23:45:05.3657199+00:00",
    "StockistType": "sample string 39",
    "DistributorChannelIdErpId": "sample string 40",
    "DistributorSegmentationIdErpId": "sample string 41",
    "State": "sample string 42",
    "PlaceOfSupply": "sample string 43",
    "WarehouseId": "sample string 44",
    "WarehouseState": "sample string 45",
    "WarehouseCity": "sample string 46",
    "WarehouseAddress": "sample string 47",
    "WarehouseName": "sample string 48",
    "WarehouseErpId": "sample string 49",
    "SecurityDeposit": "sample string 50",
    "DDNumber": "sample string 51",
    "DateOfPayment": "2025-10-19T23:45:05.3657199+00:00",
    "PaymentMode": "sample string 52",
    "IsGSTRegistered": true,
    "IntransitPeriod": 1,
    "CreditDuration": 1,
    "CreditValue": 1.1,
    "CreditInvoiceCount": 1,
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Aadhar": "sample string 54",
    "DOB": "sample string 55",
    "OwnerName": "sample string 56",
    "OwnerNo": "sample string 57",
    "CashDiscountLimit": 1.1
  },
  {
    "SuperStockistName": "sample string 1",
    "SuperStockistErpId": "sample string 2",
    "ProductDivisons": [
      "sample string 1",
      "sample string 2"
    ],
    "Id": 3,
    "Name": "sample string 4",
    "ContactNo": "sample string 5",
    "EmailId": "sample string 6",
    "SecondaryEmailId": "sample string 7",
    "Manager": "sample string 8",
    "DistributorERPId": "sample string 9",
    "LocalName": "sample string 10",
    "Address": "sample string 11",
    "City": "sample string 12",
    "Place": "sample string 13",
    "GSTIN": "sample string 14",
    "TIN": "sample string 15",
    "Pincode": "sample string 16",
    "Region": "sample string 17",
    "RegionERPId": "sample string 18",
    "Zone": "sample string 19",
    "ZoneErpId": "sample string 20",
    "GeoLevel5Name": "sample string 21",
    "GeoLevel5ErpId": "sample string 22",
    "GeoLevel6Name": "sample string 23",
    "GeoLevel6ErpId": "sample string 24",
    "GeoLevel7Name": "sample string 25",
    "GeoLevel7ErpId": "sample string 26",
    "IsDeactive": true,
    "ParentERPId": "sample string 27",
    "DistributorCategory": "sample string 28",
    "DistributorGrade": "sample string 29",
    "DistributorChannelErpId": "sample string 30",
    "PANNumber": "sample string 31",
    "FSSAINumber": "sample string 32",
    "FSSAIExiryDate": "2025-10-19T23:45:05.3657199+00:00",
    "BankName": "sample string 33",
    "BankAccountNumber": "sample string 34",
    "BankIFSCCode": "sample string 35",
    "AttributeText1": "sample string 36",
    "AttributeText2": "sample string 37",
    "AttributeText3": "sample string 38",
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeDate1": "2025-10-19T23:45:05.3657199+00:00",
    "AttributeDate2": "2025-10-19T23:45:05.3657199+00:00",
    "StockistType": "sample string 39",
    "DistributorChannelIdErpId": "sample string 40",
    "DistributorSegmentationIdErpId": "sample string 41",
    "State": "sample string 42",
    "PlaceOfSupply": "sample string 43",
    "WarehouseId": "sample string 44",
    "WarehouseState": "sample string 45",
    "WarehouseCity": "sample string 46",
    "WarehouseAddress": "sample string 47",
    "WarehouseName": "sample string 48",
    "WarehouseErpId": "sample string 49",
    "SecurityDeposit": "sample string 50",
    "DDNumber": "sample string 51",
    "DateOfPayment": "2025-10-19T23:45:05.3657199+00:00",
    "PaymentMode": "sample string 52",
    "IsGSTRegistered": true,
    "IntransitPeriod": 1,
    "CreditDuration": 1,
    "CreditValue": 1.1,
    "CreditInvoiceCount": 1,
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Aadhar": "sample string 54",
    "DOB": "sample string 55",
    "OwnerName": "sample string 56",
    "OwnerNo": "sample string 57",
    "CashDiscountLimit": 1.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfDistributorWithPDs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <DistributorWithPDs>
    <Aadhar>sample string 54</Aadhar>
    <Address>sample string 11</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-10-19T23:45:05.3657199+00:00</AttributeDate1>
    <AttributeDate2>2025-10-19T23:45:05.3657199+00:00</AttributeDate2>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeText1>sample string 36</AttributeText1>
    <AttributeText2>sample string 37</AttributeText2>
    <AttributeText3>sample string 38</AttributeText3>
    <BankAccountNumber>sample string 34</BankAccountNumber>
    <BankIFSCCode>sample string 35</BankIFSCCode>
    <BankName>sample string 33</BankName>
    <CashDiscountLimit>1.1</CashDiscountLimit>
    <City>sample string 12</City>
    <ContactNo>sample string 5</ContactNo>
    <CreditDuration>1</CreditDuration>
    <CreditInvoiceCount>1</CreditInvoiceCount>
    <CreditValue>1.1</CreditValue>
    <DDNumber>sample string 51</DDNumber>
    <DOB>sample string 55</DOB>
    <DateOfPayment>2025-10-19T23:45:05.3657199+00:00</DateOfPayment>
    <DistributorCategory>sample string 28</DistributorCategory>
    <DistributorChannelErpId>sample string 30</DistributorChannelErpId>
    <DistributorChannelIdErpId>sample string 40</DistributorChannelIdErpId>
    <DistributorERPId>sample string 9</DistributorERPId>
    <DistributorGrade>sample string 29</DistributorGrade>
    <DistributorSegmentationIdErpId>sample string 41</DistributorSegmentationIdErpId>
    <EmailId>sample string 6</EmailId>
    <FSSAIExiryDate>2025-10-19T23:45:05.3657199+00:00</FSSAIExiryDate>
    <FSSAINumber>sample string 32</FSSAINumber>
    <GSTIN>sample string 14</GSTIN>
    <GeoLevel5ErpId>sample string 22</GeoLevel5ErpId>
    <GeoLevel5Name>sample string 21</GeoLevel5Name>
    <GeoLevel6ErpId>sample string 24</GeoLevel6ErpId>
    <GeoLevel6Name>sample string 23</GeoLevel6Name>
    <GeoLevel7ErpId>sample string 26</GeoLevel7ErpId>
    <GeoLevel7Name>sample string 25</GeoLevel7Name>
    <Id>3</Id>
    <IntransitPeriod>1</IntransitPeriod>
    <IsDeactive>true</IsDeactive>
    <IsGSTRegistered>true</IsGSTRegistered>
    <Latitude>1</Latitude>
    <LocalName>sample string 10</LocalName>
    <Longitude>1</Longitude>
    <Manager>sample string 8</Manager>
    <Name>sample string 4</Name>
    <OwnerName>sample string 56</OwnerName>
    <OwnerNo>sample string 57</OwnerNo>
    <PANNumber>sample string 31</PANNumber>
    <ParentERPId>sample string 27</ParentERPId>
    <PaymentMode>sample string 52</PaymentMode>
    <Pincode>sample string 16</Pincode>
    <Place>sample string 13</Place>
    <PlaceOfSupply>sample string 43</PlaceOfSupply>
    <Region>sample string 17</Region>
    <RegionERPId>sample string 18</RegionERPId>
    <SecondaryEmailId>sample string 7</SecondaryEmailId>
    <SecurityDeposit>sample string 50</SecurityDeposit>
    <State>sample string 42</State>
    <StockistType>sample string 39</StockistType>
    <TIN>sample string 15</TIN>
    <WarehouseAddress>sample string 47</WarehouseAddress>
    <WarehouseCity>sample string 46</WarehouseCity>
    <WarehouseErpId>sample string 49</WarehouseErpId>
    <WarehouseId>sample string 44</WarehouseId>
    <WarehouseName>sample string 48</WarehouseName>
    <WarehouseState>sample string 45</WarehouseState>
    <Zone>sample string 19</Zone>
    <ZoneErpId>sample string 20</ZoneErpId>
    <ProductDivisons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductDivisons>
    <SuperStockistErpId>sample string 2</SuperStockistErpId>
    <SuperStockistName>sample string 1</SuperStockistName>
  </DistributorWithPDs>
  <DistributorWithPDs>
    <Aadhar>sample string 54</Aadhar>
    <Address>sample string 11</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-10-19T23:45:05.3657199+00:00</AttributeDate1>
    <AttributeDate2>2025-10-19T23:45:05.3657199+00:00</AttributeDate2>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeText1>sample string 36</AttributeText1>
    <AttributeText2>sample string 37</AttributeText2>
    <AttributeText3>sample string 38</AttributeText3>
    <BankAccountNumber>sample string 34</BankAccountNumber>
    <BankIFSCCode>sample string 35</BankIFSCCode>
    <BankName>sample string 33</BankName>
    <CashDiscountLimit>1.1</CashDiscountLimit>
    <City>sample string 12</City>
    <ContactNo>sample string 5</ContactNo>
    <CreditDuration>1</CreditDuration>
    <CreditInvoiceCount>1</CreditInvoiceCount>
    <CreditValue>1.1</CreditValue>
    <DDNumber>sample string 51</DDNumber>
    <DOB>sample string 55</DOB>
    <DateOfPayment>2025-10-19T23:45:05.3657199+00:00</DateOfPayment>
    <DistributorCategory>sample string 28</DistributorCategory>
    <DistributorChannelErpId>sample string 30</DistributorChannelErpId>
    <DistributorChannelIdErpId>sample string 40</DistributorChannelIdErpId>
    <DistributorERPId>sample string 9</DistributorERPId>
    <DistributorGrade>sample string 29</DistributorGrade>
    <DistributorSegmentationIdErpId>sample string 41</DistributorSegmentationIdErpId>
    <EmailId>sample string 6</EmailId>
    <FSSAIExiryDate>2025-10-19T23:45:05.3657199+00:00</FSSAIExiryDate>
    <FSSAINumber>sample string 32</FSSAINumber>
    <GSTIN>sample string 14</GSTIN>
    <GeoLevel5ErpId>sample string 22</GeoLevel5ErpId>
    <GeoLevel5Name>sample string 21</GeoLevel5Name>
    <GeoLevel6ErpId>sample string 24</GeoLevel6ErpId>
    <GeoLevel6Name>sample string 23</GeoLevel6Name>
    <GeoLevel7ErpId>sample string 26</GeoLevel7ErpId>
    <GeoLevel7Name>sample string 25</GeoLevel7Name>
    <Id>3</Id>
    <IntransitPeriod>1</IntransitPeriod>
    <IsDeactive>true</IsDeactive>
    <IsGSTRegistered>true</IsGSTRegistered>
    <Latitude>1</Latitude>
    <LocalName>sample string 10</LocalName>
    <Longitude>1</Longitude>
    <Manager>sample string 8</Manager>
    <Name>sample string 4</Name>
    <OwnerName>sample string 56</OwnerName>
    <OwnerNo>sample string 57</OwnerNo>
    <PANNumber>sample string 31</PANNumber>
    <ParentERPId>sample string 27</ParentERPId>
    <PaymentMode>sample string 52</PaymentMode>
    <Pincode>sample string 16</Pincode>
    <Place>sample string 13</Place>
    <PlaceOfSupply>sample string 43</PlaceOfSupply>
    <Region>sample string 17</Region>
    <RegionERPId>sample string 18</RegionERPId>
    <SecondaryEmailId>sample string 7</SecondaryEmailId>
    <SecurityDeposit>sample string 50</SecurityDeposit>
    <State>sample string 42</State>
    <StockistType>sample string 39</StockistType>
    <TIN>sample string 15</TIN>
    <WarehouseAddress>sample string 47</WarehouseAddress>
    <WarehouseCity>sample string 46</WarehouseCity>
    <WarehouseErpId>sample string 49</WarehouseErpId>
    <WarehouseId>sample string 44</WarehouseId>
    <WarehouseName>sample string 48</WarehouseName>
    <WarehouseState>sample string 45</WarehouseState>
    <Zone>sample string 19</Zone>
    <ZoneErpId>sample string 20</ZoneErpId>
    <ProductDivisons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductDivisons>
    <SuperStockistErpId>sample string 2</SuperStockistErpId>
    <SuperStockistName>sample string 1</SuperStockistName>
  </DistributorWithPDs>
</ArrayOfDistributorWithPDs>

Response Information

Resource Description

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/Distributor/CreateWithPDs

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