POST api/V3/Outlet/CreateUpdateOutlets

Request Information

URI Parameters

None.

Body Parameters

Collection of NewOutletMultiple
NameDescriptionTypeAdditional information
Latitude

decimal number

None.
Longitude

decimal number

None.
GeoAccuracy

decimal number

None.
Country

Name of the Country in which the Outlet is Located

 string

String length: inclusive between 0 and 100
OutletErpId

ErpId of Outlet

 string

Required
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.
Segmentation

Segmentation Options(A-,A,A+,B-,B,B+,C-,C,C+)

 string

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

None.
BeatErpId

Beat ErpId

 string

None.
SegmentationDisplayName

Segmentation Display Name

 string

None.
ChannelName

channel name of outlet

 string

None.
PlaceOfDelivery

Place Of Delivery of outlet

 string

String length: inclusive between 0 and 50
MarginName

Entity Margin Name

 string

None.
OutletName

Name of the Outlet

 string

Required

String length: inclusive between 0 and 100
ShopTypeErpId

Shop Type ErpId

 string

None.
OutletChannel

channel of outlet

 OutletChannel

None.
ShopType

string

String length: inclusive between 0 and 50
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
FormattedAddress

string

None.
Landmark

string

None.
OwnersName

Name of the Owner of the Shop/Outlet

 string

String length: inclusive between 0 and 200
OwnersNo

string

None.
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
SecondaryEmail

string

None.
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
District

string

None.
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.
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
FSSAINumber

FSAAI Number of Outlet

 string

String length: inclusive between 14 and 14
FSSAIExpiryDate

FSAAI Expiry Date

 date

None.
IsDeactive

To Deactivate an Outlet

 boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Latitude": 1.0,
    "Longitude": 1.0,
    "GeoAccuracy": 1.1,
    "Country": "sample string 1",
    "OutletErpId": "sample string 2",
    "TotalPotential": 1.1,
    "TotalCompanyPotential": 1.1,
    "TotalCompanyPotentialAlternate": 1.1,
    "Segmentation": "sample string 3",
    "RecommendationTag": "sample string 4",
    "Beat": "sample string 5",
    "BeatErpId": "sample string 6",
    "SegmentationDisplayName": "sample string 7",
    "ChannelName": "sample string 8",
    "PlaceOfDelivery": "sample string 9",
    "MarginName": "sample string 10",
    "OutletName": "sample string 11",
    "ShopTypeErpId": "sample string 12",
    "OutletChannel": "Others",
    "ShopType": "sample string 13",
    "ChannelErpId": "sample string 14",
    "OutletChannelName": "sample string 15",
    "Address": "sample string 16",
    "FormattedAddress": "sample string 17",
    "Landmark": "sample string 18",
    "OwnersName": "sample string 19",
    "OwnersNo": "sample string 20",
    "GSTIN": "sample string 21",
    "PAN": "sample string 22",
    "Aadhar": "sample string 23",
    "Email": "sample string 24",
    "SecondaryEmail": "sample string 25",
    "PinCode": "sample string 26",
    "MarketName": "sample string 27",
    "City": "sample string 28",
    "SubCity": "sample string 29",
    "District": "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 39",
    "AttributeText4": "sample string 40",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeDate1": "2025-10-19T02:25:01.1108599+00:00",
    "AttributeDate2": "2025-10-19T02:25:01.1108599+00:00",
    "FSSAINumber": "sample string 41",
    "FSSAIExpiryDate": "2025-10-19T02:25:01.1108599+00:00",
    "IsDeactive": true
  },
  {
    "Latitude": 1.0,
    "Longitude": 1.0,
    "GeoAccuracy": 1.1,
    "Country": "sample string 1",
    "OutletErpId": "sample string 2",
    "TotalPotential": 1.1,
    "TotalCompanyPotential": 1.1,
    "TotalCompanyPotentialAlternate": 1.1,
    "Segmentation": "sample string 3",
    "RecommendationTag": "sample string 4",
    "Beat": "sample string 5",
    "BeatErpId": "sample string 6",
    "SegmentationDisplayName": "sample string 7",
    "ChannelName": "sample string 8",
    "PlaceOfDelivery": "sample string 9",
    "MarginName": "sample string 10",
    "OutletName": "sample string 11",
    "ShopTypeErpId": "sample string 12",
    "OutletChannel": "Others",
    "ShopType": "sample string 13",
    "ChannelErpId": "sample string 14",
    "OutletChannelName": "sample string 15",
    "Address": "sample string 16",
    "FormattedAddress": "sample string 17",
    "Landmark": "sample string 18",
    "OwnersName": "sample string 19",
    "OwnersNo": "sample string 20",
    "GSTIN": "sample string 21",
    "PAN": "sample string 22",
    "Aadhar": "sample string 23",
    "Email": "sample string 24",
    "SecondaryEmail": "sample string 25",
    "PinCode": "sample string 26",
    "MarketName": "sample string 27",
    "City": "sample string 28",
    "SubCity": "sample string 29",
    "District": "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 39",
    "AttributeText4": "sample string 40",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeDate1": "2025-10-19T02:25:01.1108599+00:00",
    "AttributeDate2": "2025-10-19T02:25:01.1108599+00:00",
    "FSSAINumber": "sample string 41",
    "FSSAIExpiryDate": "2025-10-19T02:25:01.1108599+00:00",
    "IsDeactive": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfNewOutletMultiple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <NewOutletMultiple>
    <Aadhar>sample string 23</Aadhar>
    <AccountHoldersName>sample string 34</AccountHoldersName>
    <Address>sample string 16</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-10-19T02:25:01.1108599+00:00</AttributeDate1>
    <AttributeDate2>2025-10-19T02:25:01.1108599+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 40</AttributeText4>
    <BankAccountNumber>sample string 33</BankAccountNumber>
    <Beat>sample string 5</Beat>
    <BeatErpId>sample string 6</BeatErpId>
    <ChannelErpId>sample string 14</ChannelErpId>
    <ChannelName>sample string 8</ChannelName>
    <City>sample string 28</City>
    <Country>sample string 1</Country>
    <District>sample string 30</District>
    <Email>sample string 24</Email>
    <FSSAIExpiryDate>2025-10-19T02:25:01.1108599+00:00</FSSAIExpiryDate>
    <FSSAINumber>sample string 41</FSSAINumber>
    <FormattedAddress>sample string 17</FormattedAddress>
    <GSTIN>sample string 21</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <GeoAccuracy>1.1</GeoAccuracy>
    <IFSCCode>sample string 35</IFSCCode>
    <IsDeactive>true</IsDeactive>
    <Landmark>sample string 18</Landmark>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <MarginName>sample string 10</MarginName>
    <MarketName>sample string 27</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OutletChannelName>sample string 15</OutletChannelName>
    <OutletErpId>sample string 2</OutletErpId>
    <OutletName>sample string 11</OutletName>
    <OwnersName>sample string 19</OwnersName>
    <OwnersNo>sample string 20</OwnersNo>
    <PAN>sample string 22</PAN>
    <PinCode>sample string 26</PinCode>
    <PlaceOfDelivery>sample string 9</PlaceOfDelivery>
    <RecommendationTag>sample string 4</RecommendationTag>
    <SecondaryEmail>sample string 25</SecondaryEmail>
    <Segmentation>sample string 3</Segmentation>
    <SegmentationDisplayName>sample string 7</SegmentationDisplayName>
    <SegmentationErpId>sample string 39</SegmentationErpId>
    <ShopType>sample string 13</ShopType>
    <ShopTypeErpId>sample string 12</ShopTypeErpId>
    <State>sample string 31</State>
    <SubCity>sample string 29</SubCity>
    <TotalCompanyPotential>1.1</TotalCompanyPotential>
    <TotalCompanyPotentialAlternate>1.1</TotalCompanyPotentialAlternate>
    <TotalPotential>1.1</TotalPotential>
  </NewOutletMultiple>
  <NewOutletMultiple>
    <Aadhar>sample string 23</Aadhar>
    <AccountHoldersName>sample string 34</AccountHoldersName>
    <Address>sample string 16</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-10-19T02:25:01.1108599+00:00</AttributeDate1>
    <AttributeDate2>2025-10-19T02:25:01.1108599+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 40</AttributeText4>
    <BankAccountNumber>sample string 33</BankAccountNumber>
    <Beat>sample string 5</Beat>
    <BeatErpId>sample string 6</BeatErpId>
    <ChannelErpId>sample string 14</ChannelErpId>
    <ChannelName>sample string 8</ChannelName>
    <City>sample string 28</City>
    <Country>sample string 1</Country>
    <District>sample string 30</District>
    <Email>sample string 24</Email>
    <FSSAIExpiryDate>2025-10-19T02:25:01.1108599+00:00</FSSAIExpiryDate>
    <FSSAINumber>sample string 41</FSSAINumber>
    <FormattedAddress>sample string 17</FormattedAddress>
    <GSTIN>sample string 21</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <GeoAccuracy>1.1</GeoAccuracy>
    <IFSCCode>sample string 35</IFSCCode>
    <IsDeactive>true</IsDeactive>
    <Landmark>sample string 18</Landmark>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <MarginName>sample string 10</MarginName>
    <MarketName>sample string 27</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OutletChannelName>sample string 15</OutletChannelName>
    <OutletErpId>sample string 2</OutletErpId>
    <OutletName>sample string 11</OutletName>
    <OwnersName>sample string 19</OwnersName>
    <OwnersNo>sample string 20</OwnersNo>
    <PAN>sample string 22</PAN>
    <PinCode>sample string 26</PinCode>
    <PlaceOfDelivery>sample string 9</PlaceOfDelivery>
    <RecommendationTag>sample string 4</RecommendationTag>
    <SecondaryEmail>sample string 25</SecondaryEmail>
    <Segmentation>sample string 3</Segmentation>
    <SegmentationDisplayName>sample string 7</SegmentationDisplayName>
    <SegmentationErpId>sample string 39</SegmentationErpId>
    <ShopType>sample string 13</ShopType>
    <ShopTypeErpId>sample string 12</ShopTypeErpId>
    <State>sample string 31</State>
    <SubCity>sample string 29</SubCity>
    <TotalCompanyPotential>1.1</TotalCompanyPotential>
    <TotalCompanyPotentialAlternate>1.1</TotalCompanyPotentialAlternate>
    <TotalPotential>1.1</TotalPotential>
  </NewOutletMultiple>
</ArrayOfNewOutletMultiple>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.