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
Name

Name of the distributor.

 string

Required
ContactNo

Contact no.

 string

Matching regular expression pattern: ^[1-9]\d{9}$
EmailId

Email Id

 string

Matching regular expression pattern: ^[\D][0-9a-zA-Z\._]{1,}\@[0-9a-zA-Z\._]{2,}\.[a-zA-Z]{2,}$
SecondaryEmailId

Secondary EmailId Id

 string

Matching regular expression pattern: ^[\D][0-9a-zA-Z\._]{1,}\@[0-9a-zA-Z\._]{2,}\.[a-zA-Z]{2,}$
Manager

NAme of The contact Person

 string

None.
DistributorERPId

ERP or SAP id for the distributor.

 string

Required
LocalName

Alternate/Local for the distributor.

 string

String length: inclusive between 0 and 100
Address

Address of the Location of the distributor

 string

None.
Place

Location/City of the distributor

 string

None.
GSTIN

GSTIN (Goods and Service Tax Identity Number) No.

 string

String length: inclusive between 0 and 20
Pincode

Pincode of the Locationof the distributor

 string

Matching regular expression pattern: ^[1-9]\d{4,5}$
Region

Region of the distributor

 string

Required
IsDeactive

Set if Distributor is deactive.. (Only for Updating) This Data will be Ignored if used during Distributor Creation

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Name": "sample string 1",
    "ContactNo": "sample string 2",
    "EmailId": "sample string 3",
    "SecondaryEmailId": "sample string 4",
    "Manager": "sample string 5",
    "DistributorERPId": "sample string 6",
    "LocalName": "sample string 7",
    "Address": "sample string 8",
    "Place": "sample string 9",
    "GSTIN": "sample string 10",
    "Pincode": "sample string 11",
    "Region": "sample string 12",
    "IsDeactive": true
  },
  {
    "Name": "sample string 1",
    "ContactNo": "sample string 2",
    "EmailId": "sample string 3",
    "SecondaryEmailId": "sample string 4",
    "Manager": "sample string 5",
    "DistributorERPId": "sample string 6",
    "LocalName": "sample string 7",
    "Address": "sample string 8",
    "Place": "sample string 9",
    "GSTIN": "sample string 10",
    "Pincode": "sample string 11",
    "Region": "sample string 12",
    "IsDeactive": true
  }
]

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>
    <Address>sample string 8</Address>
    <ContactNo>sample string 2</ContactNo>
    <DistributorERPId>sample string 6</DistributorERPId>
    <EmailId>sample string 3</EmailId>
    <GSTIN>sample string 10</GSTIN>
    <IsDeactive>true</IsDeactive>
    <LocalName>sample string 7</LocalName>
    <Manager>sample string 5</Manager>
    <Name>sample string 1</Name>
    <Pincode>sample string 11</Pincode>
    <Place>sample string 9</Place>
    <Region>sample string 12</Region>
    <SecondaryEmailId>sample string 4</SecondaryEmailId>
  </Distributor>
  <Distributor>
    <Address>sample string 8</Address>
    <ContactNo>sample string 2</ContactNo>
    <DistributorERPId>sample string 6</DistributorERPId>
    <EmailId>sample string 3</EmailId>
    <GSTIN>sample string 10</GSTIN>
    <IsDeactive>true</IsDeactive>
    <LocalName>sample string 7</LocalName>
    <Manager>sample string 5</Manager>
    <Name>sample string 1</Name>
    <Pincode>sample string 11</Pincode>
    <Place>sample string 9</Place>
    <Region>sample string 12</Region>
    <SecondaryEmailId>sample string 4</SecondaryEmailId>
  </Distributor>
</ArrayOfDistributor>