POST api/V3/OutletAdditionRequest/ExternalOutletCreationRequest

Outlet Creation Request From External API to Manager App

Request Information

URI Parameters

None.

Body Parameters

Collection of ExtApi_OutletCreationRequest
NameDescriptionTypeAdditional information
ShopName

string

Required

String length: inclusive between 0 and 100
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
Email

Email of the Owner

 string

String length: inclusive between 0 and 100
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
State

Name of the State in which the Outlet is Located

 string

Required

String length: inclusive between 0 and 50
GSTN

GSTIN (Goods and Service Tax Identity Number) No. of the Outlet

 string

String length: inclusive between 0 and 20
ShopType

Retailer / Mechanics

 string

String length: inclusive between 0 and 50
Segmentation

Segmentation

 Segmentation

None.
PinCode

Area PinCode of the Location of the Outlet

 string

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

String length: inclusive between 5 and 6
Latitude

Latitude of the Geolocation

 decimal number

None.
Longitude

Latitude of the Geolocation

 decimal number

None.
BeatId

Beat Id

 integer

None.
OutletChannel

channel of outlet

 OutletChannel

None.
RouteIds

Route Ids

 string

None.
SubCity

Town/Tehsil/Village of the City in which the Outlet is Located

 string

String length: inclusive between 0 and 200
FormattedAddress

Formatted Address

 string

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

AttributeText1

 string

None.
AttributeText2

AttributeText2

 string

None.
AttributeText3

AttributeText3

 string

None.
AttributeText4

Extra attribute type text

 string

String length: inclusive between 0 and 50
AttributeNumber1

Extra attribute type decimal

 decimal number

Range: inclusive between 0 and 50
AttributeNumber2

Extra attribute type decimal

 decimal number

Range: inclusive between 0 and 50
AttributeNumber3

Extra attribute type decimal

 decimal number

Range: inclusive between 0 and 50
AttributeNumber4

Extra attribute type decimal

 decimal number

Range: inclusive between 0 and 50
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
AttributeImage1

Attribute Image1

 string

String length: inclusive between 0 and 100
AttributeImage2

Attribute Image2

 string

String length: inclusive between 0 and 100
AttributeImage3

Attribute Image3

 string

String length: inclusive between 0 and 100
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
DistributorERPId

ERP or SAP id of the distributor.

 string

Required
ShopNumber

Shop Number

 string

None.
Landmark

Land mark

 string

None.
LandlineNumber

Landline Number

 string

None.
AlternateImageId

Alternate ImageId

 string

None.
ErpId

ERP or SAP id of the Outlet.

 string

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample: 
[
  {
    "ShopName": "sample string 1",
    "Address": "sample string 2",
    "OwnersName": "sample string 3",
    "OwnersNo": "sample string 4",
    "Email": "sample string 5",
    "MarketName": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "GSTN": "sample string 9",
    "ShopType": "sample string 10",
    "Segmentation": "Undefined",
    "PinCode": "sample string 11",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "BeatId": 1,
    "OutletChannel": "Others",
    "RouteIds": "sample string 12",
    "SubCity": "sample string 13",
    "FormattedAddress": "sample string 14",
    "PAN": "sample string 15",
    "Aadhar": "sample string 16",
    "AttributeText1": "sample string 17",
    "AttributeText2": "sample string 18",
    "AttributeText3": "sample string 19",
    "AttributeText4": "sample string 20",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeDate1": "2025-04-04T05:38:37.4715571+00:00",
    "AttributeDate2": "2025-04-04T05:38:37.4715571+00:00",
    "AttributeImage1": "sample string 21",
    "AttributeImage2": "sample string 22",
    "AttributeImage3": "sample string 23",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 25",
    "AccountHoldersName": "sample string 26",
    "IFSCCode": "sample string 27",
    "DistributorERPId": "sample string 28",
    "ShopNumber": "sample string 29",
    "Landmark": "sample string 30",
    "LandlineNumber": "sample string 31",
    "AlternateImageId": "sample string 32",
    "ErpId": "sample string 33"
  },
  {
    "ShopName": "sample string 1",
    "Address": "sample string 2",
    "OwnersName": "sample string 3",
    "OwnersNo": "sample string 4",
    "Email": "sample string 5",
    "MarketName": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "GSTN": "sample string 9",
    "ShopType": "sample string 10",
    "Segmentation": "Undefined",
    "PinCode": "sample string 11",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "BeatId": 1,
    "OutletChannel": "Others",
    "RouteIds": "sample string 12",
    "SubCity": "sample string 13",
    "FormattedAddress": "sample string 14",
    "PAN": "sample string 15",
    "Aadhar": "sample string 16",
    "AttributeText1": "sample string 17",
    "AttributeText2": "sample string 18",
    "AttributeText3": "sample string 19",
    "AttributeText4": "sample string 20",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeDate1": "2025-04-04T05:38:37.4715571+00:00",
    "AttributeDate2": "2025-04-04T05:38:37.4715571+00:00",
    "AttributeImage1": "sample string 21",
    "AttributeImage2": "sample string 22",
    "AttributeImage3": "sample string 23",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 25",
    "AccountHoldersName": "sample string 26",
    "IFSCCode": "sample string 27",
    "DistributorERPId": "sample string 28",
    "ShopNumber": "sample string 29",
    "Landmark": "sample string 30",
    "LandlineNumber": "sample string 31",
    "AlternateImageId": "sample string 32",
    "ErpId": "sample string 33"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfExtApi_OutletCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <ExtApi_OutletCreationRequest>
    <Aadhar>sample string 16</Aadhar>
    <AccountHoldersName>sample string 26</AccountHoldersName>
    <Address>sample string 2</Address>
    <AlternateImageId>sample string 32</AlternateImageId>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-04-04T05:38:37.4715571+00:00</AttributeDate1>
    <AttributeDate2>2025-04-04T05:38:37.4715571+00:00</AttributeDate2>
    <AttributeImage1>sample string 21</AttributeImage1>
    <AttributeImage2>sample string 22</AttributeImage2>
    <AttributeImage3>sample string 23</AttributeImage3>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeNumber3>1.1</AttributeNumber3>
    <AttributeNumber4>1.1</AttributeNumber4>
    <AttributeText1>sample string 17</AttributeText1>
    <AttributeText2>sample string 18</AttributeText2>
    <AttributeText3>sample string 19</AttributeText3>
    <AttributeText4>sample string 20</AttributeText4>
    <BankAccountNumber>sample string 25</BankAccountNumber>
    <BeatId>1</BeatId>
    <City>sample string 7</City>
    <DistributorERPId>sample string 28</DistributorERPId>
    <Email>sample string 5</Email>
    <ErpId>sample string 33</ErpId>
    <FormattedAddress>sample string 14</FormattedAddress>
    <GSTN>sample string 9</GSTN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 27</IFSCCode>
    <LandlineNumber>sample string 31</LandlineNumber>
    <Landmark>sample string 30</Landmark>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <MarketName>sample string 6</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OwnersName>sample string 3</OwnersName>
    <OwnersNo>sample string 4</OwnersNo>
    <PAN>sample string 15</PAN>
    <PinCode>sample string 11</PinCode>
    <RouteIds>sample string 12</RouteIds>
    <Segmentation>Undefined</Segmentation>
    <ShopName>sample string 1</ShopName>
    <ShopNumber>sample string 29</ShopNumber>
    <ShopType>sample string 10</ShopType>
    <State>sample string 8</State>
    <SubCity>sample string 13</SubCity>
  </ExtApi_OutletCreationRequest>
  <ExtApi_OutletCreationRequest>
    <Aadhar>sample string 16</Aadhar>
    <AccountHoldersName>sample string 26</AccountHoldersName>
    <Address>sample string 2</Address>
    <AlternateImageId>sample string 32</AlternateImageId>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-04-04T05:38:37.4715571+00:00</AttributeDate1>
    <AttributeDate2>2025-04-04T05:38:37.4715571+00:00</AttributeDate2>
    <AttributeImage1>sample string 21</AttributeImage1>
    <AttributeImage2>sample string 22</AttributeImage2>
    <AttributeImage3>sample string 23</AttributeImage3>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeNumber3>1.1</AttributeNumber3>
    <AttributeNumber4>1.1</AttributeNumber4>
    <AttributeText1>sample string 17</AttributeText1>
    <AttributeText2>sample string 18</AttributeText2>
    <AttributeText3>sample string 19</AttributeText3>
    <AttributeText4>sample string 20</AttributeText4>
    <BankAccountNumber>sample string 25</BankAccountNumber>
    <BeatId>1</BeatId>
    <City>sample string 7</City>
    <DistributorERPId>sample string 28</DistributorERPId>
    <Email>sample string 5</Email>
    <ErpId>sample string 33</ErpId>
    <FormattedAddress>sample string 14</FormattedAddress>
    <GSTN>sample string 9</GSTN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 27</IFSCCode>
    <LandlineNumber>sample string 31</LandlineNumber>
    <Landmark>sample string 30</Landmark>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <MarketName>sample string 6</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OwnersName>sample string 3</OwnersName>
    <OwnersNo>sample string 4</OwnersNo>
    <PAN>sample string 15</PAN>
    <PinCode>sample string 11</PinCode>
    <RouteIds>sample string 12</RouteIds>
    <Segmentation>Undefined</Segmentation>
    <ShopName>sample string 1</ShopName>
    <ShopNumber>sample string 29</ShopNumber>
    <ShopType>sample string 10</ShopType>
    <State>sample string 8</State>
    <SubCity>sample string 13</SubCity>
  </ExtApi_OutletCreationRequest>
</ArrayOfExtApi_OutletCreationRequest>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

 string

None.
ResponseList

List of Errors

 Collection of ApiResponseMessage

None.
Response

Enum Indicating the Response status

 ResponseStatus

None.
ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

 ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample: 
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample: 
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>