POST api/V3/Distributor/Update
Updates a distributor
Request Information
URI Parameters
None.
Body Parameters
V3.Distributor| Name | Description | Type | Additional 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. |
| 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 |
| 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. |
Request Formats
application/json, text/json
{
"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",
"Place": "sample string 10",
"GSTIN": "sample string 11",
"TIN": "sample string 12",
"Pincode": "sample string 13",
"Region": "sample string 14",
"RegionERPId": "sample string 15",
"Zone": "sample string 16",
"ZoneErpId": "sample string 17",
"GeoLevel5Name": "sample string 18",
"GeoLevel5ErpId": "sample string 19",
"GeoLevel6Name": "sample string 20",
"GeoLevel6ErpId": "sample string 21",
"GeoLevel7Name": "sample string 22",
"GeoLevel7ErpId": "sample string 23",
"IsDeactive": true,
"ParentERPId": "sample string 24",
"DistributorCategory": "sample string 25",
"DistributorGrade": "sample string 26",
"DistributorChannelErpId": "sample string 27",
"PANNumber": "sample string 28",
"FSSAINumber": "sample string 29",
"FSSAIExiryDate": "2025-04-04T05:02:14.6595994+00:00",
"BankName": "sample string 30",
"BankAccountNumber": "sample string 31",
"BankIFSCCode": "sample string 32",
"AttributeText1": "sample string 33",
"AttributeText2": "sample string 34",
"AttributeText3": "sample string 35",
"AttributeBoolean1": true,
"AttributeBoolean2": true,
"AttributeNumber1": 1.1,
"AttributeNumber2": 1.1,
"AttributeDate1": "2025-04-04T05:02:14.6595994+00:00",
"AttributeDate2": "2025-04-04T05:02:14.6595994+00:00",
"StockistType": "sample string 36",
"DistributorChannelIdErpId": "sample string 37",
"DistributorSegmentationIdErpId": "sample string 38",
"State": "sample string 39",
"PlaceOfSupply": "sample string 40",
"WarehouseId": "sample string 41",
"WarehouseState": "sample string 42",
"WarehouseCity": "sample string 43",
"WarehouseAddress": "sample string 44",
"WarehouseName": "sample string 45",
"WarehouseErpId": "sample string 46",
"SecurityDeposit": "sample string 47",
"DDNumber": "sample string 48",
"DateOfPayment": "2025-04-04T05:02:14.6595994+00:00",
"PaymentMode": "sample string 49",
"IsGSTRegistered": true,
"IntransitPeriod": 51,
"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"
}
application/xml, text/xml
<Distributor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models"> <Aadhar>sample string 52</Aadhar> <Address>sample string 9</Address> <AttributeBoolean1>true</AttributeBoolean1> <AttributeBoolean2>true</AttributeBoolean2> <AttributeDate1>2025-04-04T05:02:14.6595994+00:00</AttributeDate1> <AttributeDate2>2025-04-04T05:02:14.6595994+00:00</AttributeDate2> <AttributeNumber1>1.1</AttributeNumber1> <AttributeNumber2>1.1</AttributeNumber2> <AttributeText1>sample string 33</AttributeText1> <AttributeText2>sample string 34</AttributeText2> <AttributeText3>sample string 35</AttributeText3> <BankAccountNumber>sample string 31</BankAccountNumber> <BankIFSCCode>sample string 32</BankIFSCCode> <BankName>sample string 30</BankName> <ContactNo>sample string 3</ContactNo> <CreditDuration>1</CreditDuration> <CreditInvoiceCount>1</CreditInvoiceCount> <CreditValue>1.1</CreditValue> <DDNumber>sample string 48</DDNumber> <DOB>sample string 53</DOB> <DateOfPayment>2025-04-04T05:02:14.6595994+00:00</DateOfPayment> <DistributorCategory>sample string 25</DistributorCategory> <DistributorChannelErpId>sample string 27</DistributorChannelErpId> <DistributorChannelIdErpId>sample string 37</DistributorChannelIdErpId> <DistributorERPId>sample string 7</DistributorERPId> <DistributorGrade>sample string 26</DistributorGrade> <DistributorSegmentationIdErpId>sample string 38</DistributorSegmentationIdErpId> <EmailId>sample string 4</EmailId> <FSSAIExiryDate>2025-04-04T05:02:14.6595994+00:00</FSSAIExiryDate> <FSSAINumber>sample string 29</FSSAINumber> <GSTIN>sample string 11</GSTIN> <GeoLevel5ErpId>sample string 19</GeoLevel5ErpId> <GeoLevel5Name>sample string 18</GeoLevel5Name> <GeoLevel6ErpId>sample string 21</GeoLevel6ErpId> <GeoLevel6Name>sample string 20</GeoLevel6Name> <GeoLevel7ErpId>sample string 23</GeoLevel7ErpId> <GeoLevel7Name>sample string 22</GeoLevel7Name> <Id>1</Id> <IntransitPeriod>51</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 28</PANNumber> <ParentERPId>sample string 24</ParentERPId> <PaymentMode>sample string 49</PaymentMode> <Pincode>sample string 13</Pincode> <Place>sample string 10</Place> <PlaceOfSupply>sample string 40</PlaceOfSupply> <Region>sample string 14</Region> <RegionERPId>sample string 15</RegionERPId> <SecondaryEmailId>sample string 5</SecondaryEmailId> <SecurityDeposit>sample string 47</SecurityDeposit> <State>sample string 39</State> <StockistType>sample string 36</StockistType> <TIN>sample string 12</TIN> <WarehouseAddress>sample string 44</WarehouseAddress> <WarehouseCity>sample string 43</WarehouseCity> <WarehouseErpId>sample string 46</WarehouseErpId> <WarehouseId>sample string 41</WarehouseId> <WarehouseName>sample string 45</WarehouseName> <WarehouseState>sample string 42</WarehouseState> <Zone>sample string 16</Zone> <ZoneErpId>sample string 17</ZoneErpId> </Distributor>
Response Information
Resource Description
ApiResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| ERPId |
ERPID of the Requested insertion/updation |
string |
None. |
| Message |
Error Message for the indicated ERPID |
string |
None. |
| ResponseStatus |
Status of the action requested from Api |
ResponseStatus |
None. |
| GUID |
GUID of the database Entry with respect to the ERP Id Provided |
string |
None. |
Response Formats
application/json, text/json
{
"ERPId": "sample string 1",
"Message": "sample string 2",
"ResponseStatus": "Failure",
"GUID": "sample string 3"
}
application/xml, text/xml
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common"> <ERPId>sample string 1</ERPId> <GUID>sample string 3</GUID> <Message>sample string 2</Message> <ResponseStatus>Failure</ResponseStatus> </ApiResponseMessage>