POST api/V3/Outlet/Create

Create new outlet.

Request Information

URI Parameters

None.

Body Parameters

Outlet to be added

V3.Outlet
NameDescriptionTypeAdditional information
Latitude

Latitude of the Geolocation

 decimal number

None.
Longitude

Latitude of the Geolocation

 decimal number

None.
OutletGuid

Guid of an Outlet (only for Viewing, Will be created new During Additions)

 string

None.
RouteErpId

EripId of the Route

 string

String length: inclusive between 0 and 100
GeoAccuracy

GeoAccuracy of the Outlet

 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

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

Sample: 
{
  "Latitude": 1.0,
  "Longitude": 1.0,
  "OutletGuid": "sample string 1",
  "RouteErpId": "sample string 2",
  "GeoAccuracy": 1.1,
  "Country": "sample string 3",
  "OutletErpId": "sample string 4",
  "TotalPotential": 1.1,
  "TotalCompanyPotential": 1.1,
  "TotalCompanyPotentialAlternate": 1.1,
  "SegmentationScope": "sample string 5",
  "Segmentation": "sample string 6",
  "Focused": true,
  "RecommendationTag": "sample string 8",
  "Beat": "sample string 9",
  "SegmentationDisplayName": "sample string 10",
  "ChannelName": "sample string 11",
  "CFStatus": "NotEligible",
  "PlaceOfDelivery": "sample string 12",
  "FSSAINumber": "sample string 13",
  "FSSAIExpiryDate": "2025-10-18T10:45:48.6058313+00:00",
  "MarginName": "sample string 14",
  "OutletName": "sample string 15",
  "ShopType": "sample string 16",
  "ShopTypeErpId": "sample string 17",
  "OutletChannel": "Others",
  "ChannelErpId": "sample string 18",
  "OutletChannelName": "sample string 19",
  "Address": "sample string 20",
  "OwnersName": "sample string 21",
  "OwnersNo": "sample string 22",
  "TIN": "sample string 23",
  "GSTIN": "sample string 24",
  "PAN": "sample string 25",
  "Aadhar": "sample string 26",
  "Email": "sample string 27",
  "PinCode": "sample string 28",
  "MarketName": "sample string 29",
  "City": "sample string 30",
  "SubCity": "sample string 31",
  "State": "sample string 32",
  "GSTRegistered": true,
  "BankAccountNumber": "sample string 34",
  "AccountHoldersName": "sample string 35",
  "IFSCCode": "sample string 36",
  "AttributeText1": "sample string 37",
  "AttributeText2": "sample string 38",
  "AttributeText3": "sample string 39",
  "SegmentationErpId": "sample string 41",
  "AttributeText4": "sample string 42",
  "AttributeNumber1": 1.1,
  "AttributeNumber2": 1.1,
  "AttributeNumber3": 1.1,
  "AttributeNumber4": 1.1,
  "AttributeBoolean1": true,
  "AttributeBoolean2": true,
  "AttributeDate1": "2025-10-18T10:45:48.6214552+00:00",
  "AttributeDate2": "2025-10-18T10:45:48.6214552+00:00",
  "EpochTime": 43
}

application/xml, text/xml

Sample: 
<Outlet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <Aadhar>sample string 26</Aadhar>
  <AccountHoldersName>sample string 35</AccountHoldersName>
  <Address>sample string 20</Address>
  <AttributeBoolean1>true</AttributeBoolean1>
  <AttributeBoolean2>true</AttributeBoolean2>
  <AttributeDate1>2025-10-18T10:45:48.6214552+00:00</AttributeDate1>
  <AttributeDate2>2025-10-18T10:45:48.6214552+00:00</AttributeDate2>
  <AttributeNumber1>1.1</AttributeNumber1>
  <AttributeNumber2>1.1</AttributeNumber2>
  <AttributeNumber3>1.1</AttributeNumber3>
  <AttributeNumber4>1.1</AttributeNumber4>
  <AttributeText1>sample string 37</AttributeText1>
  <AttributeText2>sample string 38</AttributeText2>
  <AttributeText3>sample string 39</AttributeText3>
  <AttributeText4>sample string 42</AttributeText4>
  <BankAccountNumber>sample string 34</BankAccountNumber>
  <ChannelErpId>sample string 18</ChannelErpId>
  <City>sample string 30</City>
  <Email>sample string 27</Email>
  <EpochTime>43</EpochTime>
  <GSTIN>sample string 24</GSTIN>
  <GSTRegistered>true</GSTRegistered>
  <IFSCCode>sample string 36</IFSCCode>
  <MarketName>sample string 29</MarketName>
  <OutletChannel>Others</OutletChannel>
  <OutletChannelName>sample string 19</OutletChannelName>
  <OutletName>sample string 15</OutletName>
  <OwnersName>sample string 21</OwnersName>
  <OwnersNo>sample string 22</OwnersNo>
  <PAN>sample string 25</PAN>
  <PinCode>sample string 28</PinCode>
  <Segmentation xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:int">40</Segmentation>
  <SegmentationDisplayName i:nil="true" />
  <SegmentationErpId>sample string 41</SegmentationErpId>
  <ShopType>sample string 16</ShopType>
  <ShopTypeErpId>sample string 17</ShopTypeErpId>
  <State>sample string 32</State>
  <SubCity>sample string 31</SubCity>
  <TIN>sample string 23</TIN>
  <Beat>sample string 9</Beat>
  <CFStatus>NotEligible</CFStatus>
  <ChannelName>sample string 11</ChannelName>
  <Country>sample string 3</Country>
  <FSSAIExpiryDate>2025-10-18T10:45:48.6058313+00:00</FSSAIExpiryDate>
  <FSSAINumber>sample string 13</FSSAINumber>
  <Focused>true</Focused>
  <MarginName>sample string 14</MarginName>
  <OutletErpId>sample string 4</OutletErpId>
  <PlaceOfDelivery>sample string 12</PlaceOfDelivery>
  <RecommendationTag>sample string 8</RecommendationTag>
  <Segmentation xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:string">sample string 6</Segmentation>
  <SegmentationDisplayName>sample string 10</SegmentationDisplayName>
  <SegmentationScope>sample string 5</SegmentationScope>
  <TotalCompanyPotential>1.1</TotalCompanyPotential>
  <TotalCompanyPotentialAlternate>1.1</TotalCompanyPotentialAlternate>
  <TotalPotential>1.1</TotalPotential>
  <GeoAccuracy>1.1</GeoAccuracy>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <OutletGuid>sample string 1</OutletGuid>
  <RouteErpId>sample string 2</RouteErpId>
</Outlet>

Response Information

Resource Description

Response Description with message and GUID or, ErrorMessage as String

ApiResponseMessage
NameDescriptionTypeAdditional 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

Sample: 
{
  "ERPId": "sample string 1",
  "Message": "sample string 2",
  "ResponseStatus": "Failure",
  "GUID": "sample string 3"
}

application/xml, text/xml

Sample: 
<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>