GET api/V3/OutletAdditionRequest/list?LastRequestId={LastRequestId}&IsManagerApproved={IsManagerApproved}

Fetches the 100 Outlet Creation requests after the LastRequestId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
LastRequestId

The Last Request Id after which the requests are to be fetched

integer

Default value is 0

IsManagerApproved

If we need manager approved outlets only.Values will be true or false

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of OutletCreationRequest
NameDescriptionTypeAdditional information
ApprovedByManager

Boolean to show if it is Approved By Manager

boolean

None.

Latitude

Latitude of Outlet

decimal number

None.

Longitude

Longitude of the Outlet

decimal number

None.

Beat

Beat Name of the Outlet

string

None.

Territory

Territory of the Beat of the Outlet

string

None.

Region

Region for the Territory of the Outlet

string

None.

Zone

Zone for the region of the Outlet

string

None.

EmployeeName

Name of the Employee who Requested the Outlet Creation

string

None.

EmpoyeeERPId

Erp/Sap Id of the Employee who Requested the Outlet Creation

string

None.

Time

Time of the Request for the Outlet Creation

date

None.

Route

attached route details

Collection of RouteData

None.

DistributorErpId

Distributor ErpId of the Outlet

string

None.

PanCard

PAN Card of the Outlet

string

None.

ChannelErpId

PAN Card of the Outlet

string

None.

Landline

landline of outlet

string

None.

SizeOfShop

size of shop

integer

None.

SizeOfArea

size of area in shop for display

integer

None.

ShopPhoto

photo of shop

string

None.

AlternateShopPhoto

alternate shop photo

string

None.

TypeOfId

type of id proof

string

None.

IdProofPhoto

if proof photo

string

None.

ModeOfDataCollection

mode of collection

string

None.

ShopNumber

string

None.

RequestId

Request id

integer

Required

OutletName

Name of the Outlet

string

Required

String length: inclusive between 0 and 100

OutletErpId

ErpId/SAPId of the Outlet

string

Required

String length: inclusive between 1 and 50

Address

Address of the Outlet

string

String length: inclusive between 0 and 1000

ShopType

ShopType

string

String length: inclusive between 0 and 50

ShopTypeErpId

ShopType

string

String length: inclusive between 0 and 50

MarketName

Market Name in which the Outlet is located

string

None.

State

State in which Outlet is located

string

None.

OwnersName

Name of the Outlet Owner/Manager

string

String length: inclusive between 0 and 200

City

City in which the Outlet is Located

string

Required

String length: inclusive between 0 and 30

OwnersNo

Contact No of the Outlet Owner/Manager

string

String length: inclusive between 0 and 20

GSTIN

GSTIN No of the Outlet

string

String length: inclusive between 0 and 16

Email

EmailId of the Owner of the Outlet

string

String length: inclusive between 0 and 100

PinCode

PinCode of the Area in which the Outlet is Located

string

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

String length: inclusive between 5 and 6

Segmentation

Outlet Segmentation

Segmentation

None.

OutletChannel

Outlet Channel

OutletChannel

None.

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

string

None.

AttributeText2

string

None.

AttributeText3

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ApprovedByManager": true,
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Beat": "sample string 2",
    "Territory": "sample string 3",
    "Region": "sample string 4",
    "Zone": "sample string 5",
    "EmployeeName": "sample string 6",
    "EmpoyeeERPId": "sample string 7",
    "Time": "2026-01-07T07:08:38.6611759+00:00",
    "Route": [
      {
        "Name": "sample string 1",
        "ErpId": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "ErpId": "sample string 2"
      }
    ],
    "DistributorErpId": "sample string 9",
    "PanCard": "sample string 10",
    "ChannelErpId": "sample string 11",
    "Landline": "sample string 12",
    "SizeOfShop": 13,
    "SizeOfArea": 14,
    "ShopPhoto": "sample string 15",
    "AlternateShopPhoto": "sample string 16",
    "TypeOfId": "sample string 17",
    "IdProofPhoto": "sample string 18",
    "ModeOfDataCollection": "sample string 19",
    "ShopNumber": "sample string 20",
    "RequestId": 21,
    "OutletName": "sample string 22",
    "OutletErpId": "sample string 23",
    "Address": "sample string 24",
    "ShopType": "sample string 25",
    "ShopTypeErpId": "sample string 26",
    "MarketName": "sample string 27",
    "State": "sample string 28",
    "OwnersName": "sample string 29",
    "City": "sample string 30",
    "OwnersNo": "sample string 31",
    "GSTIN": "sample string 32",
    "Email": "sample string 33",
    "PinCode": "sample string 34",
    "Segmentation": "Undefined",
    "OutletChannel": "Others",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 36",
    "AccountHoldersName": "sample string 37",
    "IFSCCode": "sample string 38",
    "AttributeText1": "sample string 39",
    "AttributeText2": "sample string 40",
    "AttributeText3": "sample string 41"
  },
  {
    "ApprovedByManager": true,
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Beat": "sample string 2",
    "Territory": "sample string 3",
    "Region": "sample string 4",
    "Zone": "sample string 5",
    "EmployeeName": "sample string 6",
    "EmpoyeeERPId": "sample string 7",
    "Time": "2026-01-07T07:08:38.6611759+00:00",
    "Route": [
      {
        "Name": "sample string 1",
        "ErpId": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "ErpId": "sample string 2"
      }
    ],
    "DistributorErpId": "sample string 9",
    "PanCard": "sample string 10",
    "ChannelErpId": "sample string 11",
    "Landline": "sample string 12",
    "SizeOfShop": 13,
    "SizeOfArea": 14,
    "ShopPhoto": "sample string 15",
    "AlternateShopPhoto": "sample string 16",
    "TypeOfId": "sample string 17",
    "IdProofPhoto": "sample string 18",
    "ModeOfDataCollection": "sample string 19",
    "ShopNumber": "sample string 20",
    "RequestId": 21,
    "OutletName": "sample string 22",
    "OutletErpId": "sample string 23",
    "Address": "sample string 24",
    "ShopType": "sample string 25",
    "ShopTypeErpId": "sample string 26",
    "MarketName": "sample string 27",
    "State": "sample string 28",
    "OwnersName": "sample string 29",
    "City": "sample string 30",
    "OwnersNo": "sample string 31",
    "GSTIN": "sample string 32",
    "Email": "sample string 33",
    "PinCode": "sample string 34",
    "Segmentation": "Undefined",
    "OutletChannel": "Others",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 36",
    "AccountHoldersName": "sample string 37",
    "IFSCCode": "sample string 38",
    "AttributeText1": "sample string 39",
    "AttributeText2": "sample string 40",
    "AttributeText3": "sample string 41"
  }
]

application/xml, text/xml

Sample:
<ArrayOfOutletCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <OutletCreationRequest>
    <AccountHoldersName>sample string 37</AccountHoldersName>
    <Address>sample string 24</Address>
    <AttributeText1>sample string 39</AttributeText1>
    <AttributeText2>sample string 40</AttributeText2>
    <AttributeText3>sample string 41</AttributeText3>
    <BankAccountNumber>sample string 36</BankAccountNumber>
    <City>sample string 30</City>
    <Email>sample string 33</Email>
    <GSTIN>sample string 32</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 38</IFSCCode>
    <MarketName>sample string 27</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OutletErpId>sample string 23</OutletErpId>
    <OutletName>sample string 22</OutletName>
    <OwnersName>sample string 29</OwnersName>
    <OwnersNo>sample string 31</OwnersNo>
    <PinCode>sample string 34</PinCode>
    <RequestId>21</RequestId>
    <Segmentation>Undefined</Segmentation>
    <ShopType>sample string 25</ShopType>
    <ShopTypeErpId>sample string 26</ShopTypeErpId>
    <State>sample string 28</State>
    <AlternateShopPhoto>sample string 16</AlternateShopPhoto>
    <ApprovedByManager>true</ApprovedByManager>
    <Beat>sample string 2</Beat>
    <ChannelErpId>sample string 11</ChannelErpId>
    <DistributorErpId>sample string 9</DistributorErpId>
    <EmployeeName>sample string 6</EmployeeName>
    <EmpoyeeERPId>sample string 7</EmpoyeeERPId>
    <IdProofPhoto>sample string 18</IdProofPhoto>
    <Landline>sample string 12</Landline>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <ModeOfDataCollection>sample string 19</ModeOfDataCollection>
    <PanCard>sample string 10</PanCard>
    <Region>sample string 4</Region>
    <Route>
      <RouteData>
        <ErpId>sample string 2</ErpId>
        <Name>sample string 1</Name>
      </RouteData>
      <RouteData>
        <ErpId>sample string 2</ErpId>
        <Name>sample string 1</Name>
      </RouteData>
    </Route>
    <ShopNumber>sample string 20</ShopNumber>
    <ShopPhoto>sample string 15</ShopPhoto>
    <SizeOfArea>14</SizeOfArea>
    <SizeOfShop>13</SizeOfShop>
    <Territory>sample string 3</Territory>
    <Time>2026-01-07T07:08:38.6611759+00:00</Time>
    <TypeOfId>sample string 17</TypeOfId>
    <Zone>sample string 5</Zone>
  </OutletCreationRequest>
  <OutletCreationRequest>
    <AccountHoldersName>sample string 37</AccountHoldersName>
    <Address>sample string 24</Address>
    <AttributeText1>sample string 39</AttributeText1>
    <AttributeText2>sample string 40</AttributeText2>
    <AttributeText3>sample string 41</AttributeText3>
    <BankAccountNumber>sample string 36</BankAccountNumber>
    <City>sample string 30</City>
    <Email>sample string 33</Email>
    <GSTIN>sample string 32</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 38</IFSCCode>
    <MarketName>sample string 27</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OutletErpId>sample string 23</OutletErpId>
    <OutletName>sample string 22</OutletName>
    <OwnersName>sample string 29</OwnersName>
    <OwnersNo>sample string 31</OwnersNo>
    <PinCode>sample string 34</PinCode>
    <RequestId>21</RequestId>
    <Segmentation>Undefined</Segmentation>
    <ShopType>sample string 25</ShopType>
    <ShopTypeErpId>sample string 26</ShopTypeErpId>
    <State>sample string 28</State>
    <AlternateShopPhoto>sample string 16</AlternateShopPhoto>
    <ApprovedByManager>true</ApprovedByManager>
    <Beat>sample string 2</Beat>
    <ChannelErpId>sample string 11</ChannelErpId>
    <DistributorErpId>sample string 9</DistributorErpId>
    <EmployeeName>sample string 6</EmployeeName>
    <EmpoyeeERPId>sample string 7</EmpoyeeERPId>
    <IdProofPhoto>sample string 18</IdProofPhoto>
    <Landline>sample string 12</Landline>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <ModeOfDataCollection>sample string 19</ModeOfDataCollection>
    <PanCard>sample string 10</PanCard>
    <Region>sample string 4</Region>
    <Route>
      <RouteData>
        <ErpId>sample string 2</ErpId>
        <Name>sample string 1</Name>
      </RouteData>
      <RouteData>
        <ErpId>sample string 2</ErpId>
        <Name>sample string 1</Name>
      </RouteData>
    </Route>
    <ShopNumber>sample string 20</ShopNumber>
    <ShopPhoto>sample string 15</ShopPhoto>
    <SizeOfArea>14</SizeOfArea>
    <SizeOfShop>13</SizeOfShop>
    <Territory>sample string 3</Territory>
    <Time>2026-01-07T07:08:38.6611759+00:00</Time>
    <TypeOfId>sample string 17</TypeOfId>
    <Zone>sample string 5</Zone>
  </OutletCreationRequest>
</ArrayOfOutletCreationRequest>