GET api/V3/Distributor/list

Lists All the Distributors

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of V3.Distributor
NameDescriptionTypeAdditional information
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.

Response Formats

application/json, text/json

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

application/xml, text/xml

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