POST api/V3/Outlet/Update
Update outlet.
Request Information
URI Parameters
None.
Body Parameters
Outlet to be update
V3.OutletUpdateName | Description | Type | Additional information |
---|---|---|---|
Blocked |
Is this Distributor inActive/ Deleted/ Blocked? |
boolean |
None. |
TagNames |
List of Custom Tags Names to be attached to Outlet |
Collection of string |
None. |
GeoAccuracy |
GeoAccuracy of the Outlet |
decimal number |
None. |
Latitude |
Latitude of the Location |
decimal number |
None. |
Longitude |
Latitude of the Location |
decimal number |
None. |
Country |
Name of the Country in which the Outlet is Located |
string |
String length: inclusive between 0 and 100 |
OutletErpId |
SAP or ERP id of the Outlet/Customer |
string |
None. |
TotalPotential |
Total Potential of the Outlet in Local Currency Value |
decimal number |
None. |
TotalCompanyPotential |
Total Potential of the Company of the Outlet in Local Currency Value |
decimal number |
None. |
TotalCompanyPotentialAlternate |
Total Alternate Potential of the Outlet in Local Currency Value |
decimal number |
None. |
SegmentationScope |
Scope of the Segmentation |
string |
None. |
Segmentation |
Segmentation Options(A-,A,A+,B-,B,B+,C-,C,C+) |
string |
None. |
Focused |
Is the Shop Focussed and Should it be highlighted |
boolean |
None. |
RecommendationTag |
Name of the Reccomendation Tag which will be used to Recommend Products on Outlet |
string |
String length: inclusive between 0 and 500 |
Beat |
Beat Name |
string |
Required |
SegmentationDisplayName | string |
None. |
|
ChannelName |
channel name of outlet |
string |
None. |
CFStatus | CFStatus |
None. |
|
PlaceOfDelivery |
Place Of Delivery of outlet |
string |
String length: inclusive between 0 and 50 |
FSSAINumber |
FSAAI Number of Outlet |
string |
String length: inclusive between 14 and 14 |
FSSAIExpiryDate |
FSAAI Expiry Date |
date |
None. |
MarginName |
Entity Margin Name |
string |
None. |
OutletName |
Name of the Outlet |
string |
Required String length: inclusive between 0 and 100 |
ShopType |
Retailer / Mechanics |
string |
String length: inclusive between 0 and 50 |
ShopTypeErpId |
Shop Type ErpId |
string |
None. |
OutletChannel |
channel of outlet |
OutletChannel |
None. |
ChannelErpId |
channel ErpId of outlet |
string |
None. |
OutletChannelName |
Custom channel Name of outlet |
string |
None. |
Address |
Address of the Shop |
string |
Required String length: inclusive between 0 and 1000 |
OwnersName |
Name of the Owner of the Shop/Outlet |
string |
String length: inclusive between 0 and 200 |
OwnersNo |
Contact Number of the Owner |
string |
String length: inclusive between 0 and 20 |
TIN |
TIN (Tax Information Network) No. of the Outlet |
string |
String length: inclusive between 0 and 20 |
GSTIN |
GSTIN (Goods and Service Tax Identity Number) No. of the Outlet |
string |
String length: inclusive between 0 and 20 |
PAN |
Pan Number |
string |
Matching regular expression pattern: ^[a-zA-Z0-9]{10,10}$ String length: inclusive between 0 and 10 |
Aadhar |
Aadhar Number |
string |
Matching regular expression pattern: ^[0-9]{12,12}$ String length: inclusive between 0 and 12 |
Email of the Owner |
string |
String length: inclusive between 0 and 100 |
|
PinCode |
Area PinCode of the Location of the Outlet |
string |
Matching regular expression pattern: ^[1-9]\d{3,5}$ String length: inclusive between 4 and 6 |
MarketName |
Name of the Market in which the Outlet is Located |
string |
Required String length: inclusive between 0 and 50 |
City |
Name of the City in which the Outlet is Located |
string |
Required String length: inclusive between 0 and 50 |
SubCity |
Town/Tehsil/Village of the City in which the Outlet is Located |
string |
String length: inclusive between 0 and 200 |
State |
Name of the State in which the Outlet is Located |
string |
String length: inclusive between 0 and 50 |
GSTRegistered |
GST Registered |
boolean |
None. |
BankAccountNumber |
Bank Account Number |
string |
String length: inclusive between 0 and 18 |
AccountHoldersName |
Account Holders Name |
string |
None. |
IFSCCode |
IFSC Code |
string |
String length: inclusive between 0 and 11 |
AttributeText1 |
AttributeText1 |
string |
None. |
AttributeText2 |
AttributeText2 |
string |
None. |
AttributeText3 |
AttributeText3 |
string |
None. |
Segmentation |
Segmentation |
integer |
None. |
SegmentationErpId |
Segmentation ErpId |
string |
None. |
AttributeText4 |
Extra attribute type text |
string |
String length: inclusive between 0 and 50 |
AttributeNumber1 |
Extra attribute type decimal |
decimal number |
None. |
AttributeNumber2 |
Extra attribute type decimal |
decimal number |
None. |
AttributeNumber3 |
Extra attribute type decimal |
decimal number |
None. |
AttributeNumber4 |
Extra attribute type decimal |
decimal number |
None. |
AttributeBoolean1 |
Extra attribute type boolean |
boolean |
None. |
AttributeBoolean2 |
Extra attribute type boolean |
boolean |
None. |
AttributeDate1 |
Extra attribute type date |
date |
Data type: Date |
AttributeDate2 |
Extra attribute type date |
date |
Data type: Date |
EpochTime |
Epoch Time for the updated outlet |
integer |
None. |
Request Formats
application/json, text/json
{ "Blocked": true, "TagNames": [ "sample string 1", "sample string 2" ], "GeoAccuracy": 1.1, "Latitude": 1.0, "Longitude": 1.0, "Country": "sample string 2", "OutletErpId": "sample string 3", "TotalPotential": 1.1, "TotalCompanyPotential": 1.1, "TotalCompanyPotentialAlternate": 1.1, "SegmentationScope": "sample string 4", "Segmentation": "sample string 5", "Focused": true, "RecommendationTag": "sample string 7", "Beat": "sample string 8", "SegmentationDisplayName": "sample string 9", "ChannelName": "sample string 10", "CFStatus": "NotEligible", "PlaceOfDelivery": "sample string 11", "FSSAINumber": "sample string 12", "FSSAIExpiryDate": "2025-04-04T04:58:24.3564544+00:00", "MarginName": "sample string 13", "OutletName": "sample string 14", "ShopType": "sample string 15", "ShopTypeErpId": "sample string 16", "OutletChannel": "Others", "ChannelErpId": "sample string 17", "OutletChannelName": "sample string 18", "Address": "sample string 19", "OwnersName": "sample string 20", "OwnersNo": "sample string 21", "TIN": "sample string 22", "GSTIN": "sample string 23", "PAN": "sample string 24", "Aadhar": "sample string 25", "Email": "sample string 26", "PinCode": "sample string 27", "MarketName": "sample string 28", "City": "sample string 29", "SubCity": "sample string 30", "State": "sample string 31", "GSTRegistered": true, "BankAccountNumber": "sample string 33", "AccountHoldersName": "sample string 34", "IFSCCode": "sample string 35", "AttributeText1": "sample string 36", "AttributeText2": "sample string 37", "AttributeText3": "sample string 38", "SegmentationErpId": "sample string 40", "AttributeText4": "sample string 41", "AttributeNumber1": 1.1, "AttributeNumber2": 1.1, "AttributeNumber3": 1.1, "AttributeNumber4": 1.1, "AttributeBoolean1": true, "AttributeBoolean2": true, "AttributeDate1": "2025-04-04T04:58:24.3564544+00:00", "AttributeDate2": "2025-04-04T04:58:24.3564544+00:00", "EpochTime": 42 }
application/xml, text/xml
<OutletUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models"> <Aadhar>sample string 25</Aadhar> <AccountHoldersName>sample string 34</AccountHoldersName> <Address>sample string 19</Address> <AttributeBoolean1>true</AttributeBoolean1> <AttributeBoolean2>true</AttributeBoolean2> <AttributeDate1>2025-04-04T04:58:24.3564544+00:00</AttributeDate1> <AttributeDate2>2025-04-04T04:58:24.3564544+00:00</AttributeDate2> <AttributeNumber1>1.1</AttributeNumber1> <AttributeNumber2>1.1</AttributeNumber2> <AttributeNumber3>1.1</AttributeNumber3> <AttributeNumber4>1.1</AttributeNumber4> <AttributeText1>sample string 36</AttributeText1> <AttributeText2>sample string 37</AttributeText2> <AttributeText3>sample string 38</AttributeText3> <AttributeText4>sample string 41</AttributeText4> <BankAccountNumber>sample string 33</BankAccountNumber> <ChannelErpId>sample string 17</ChannelErpId> <City>sample string 29</City> <Email>sample string 26</Email> <EpochTime>42</EpochTime> <GSTIN>sample string 23</GSTIN> <GSTRegistered>true</GSTRegistered> <IFSCCode>sample string 35</IFSCCode> <MarketName>sample string 28</MarketName> <OutletChannel>Others</OutletChannel> <OutletChannelName>sample string 18</OutletChannelName> <OutletName>sample string 14</OutletName> <OwnersName>sample string 20</OwnersName> <OwnersNo>sample string 21</OwnersNo> <PAN>sample string 24</PAN> <PinCode>sample string 27</PinCode> <Segmentation xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:int">39</Segmentation> <SegmentationDisplayName i:nil="true" /> <SegmentationErpId>sample string 40</SegmentationErpId> <ShopType>sample string 15</ShopType> <ShopTypeErpId>sample string 16</ShopTypeErpId> <State>sample string 31</State> <SubCity>sample string 30</SubCity> <TIN>sample string 22</TIN> <Beat>sample string 8</Beat> <CFStatus>NotEligible</CFStatus> <ChannelName>sample string 10</ChannelName> <Country>sample string 2</Country> <FSSAIExpiryDate>2025-04-04T04:58:24.3564544+00:00</FSSAIExpiryDate> <FSSAINumber>sample string 12</FSSAINumber> <Focused>true</Focused> <MarginName>sample string 13</MarginName> <OutletErpId>sample string 3</OutletErpId> <PlaceOfDelivery>sample string 11</PlaceOfDelivery> <RecommendationTag>sample string 7</RecommendationTag> <Segmentation xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:string">sample string 5</Segmentation> <SegmentationDisplayName>sample string 9</SegmentationDisplayName> <SegmentationScope>sample string 4</SegmentationScope> <TotalCompanyPotential>1.1</TotalCompanyPotential> <TotalCompanyPotentialAlternate>1.1</TotalCompanyPotentialAlternate> <TotalPotential>1.1</TotalPotential> <Blocked>true</Blocked> <GeoAccuracy>1.1</GeoAccuracy> <Latitude>1</Latitude> <Longitude>1</Longitude> <TagNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TagNames> </OutletUpdate>
Response Information
Resource Description
Response Description with message and GUID or, ErrorMessage as String
ApiResponseMessageName | 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>