POST api/V3/OutletAdditionRequest/review

Reviews and Saves the Location as per Request Approval, Max 100 Addition Requests can be executed in one Request

Request Information

URI Parameters

None.

Body Parameters

Collection of ReviewOutletCreationRequest

Name	Description	Type	Additional information
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.
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

Request Formats

application/json, text/json

Sample:

[
  {
    "RequestId": 1,
    "OutletName": "sample string 2",
    "OutletErpId": "sample string 3",
    "Address": "sample string 4",
    "ShopType": "sample string 5",
    "ShopTypeErpId": "sample string 6",
    "MarketName": "sample string 7",
    "State": "sample string 8",
    "OwnersName": "sample string 9",
    "City": "sample string 10",
    "OwnersNo": "sample string 11",
    "GSTIN": "sample string 12",
    "Email": "sample string 13",
    "PinCode": "sample string 14",
    "Segmentation": "Undefined",
    "OutletChannel": "Others",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 16",
    "AccountHoldersName": "sample string 17",
    "IFSCCode": "sample string 18",
    "AttributeText1": "sample string 19",
    "AttributeText2": "sample string 20",
    "AttributeText3": "sample string 21",
    "AttributeText4": "sample string 22",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeDate1": "2025-04-04T05:14:13.7617469+00:00",
    "AttributeDate2": "2025-04-04T05:14:13.7617469+00:00"
  },
  {
    "RequestId": 1,
    "OutletName": "sample string 2",
    "OutletErpId": "sample string 3",
    "Address": "sample string 4",
    "ShopType": "sample string 5",
    "ShopTypeErpId": "sample string 6",
    "MarketName": "sample string 7",
    "State": "sample string 8",
    "OwnersName": "sample string 9",
    "City": "sample string 10",
    "OwnersNo": "sample string 11",
    "GSTIN": "sample string 12",
    "Email": "sample string 13",
    "PinCode": "sample string 14",
    "Segmentation": "Undefined",
    "OutletChannel": "Others",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 16",
    "AccountHoldersName": "sample string 17",
    "IFSCCode": "sample string 18",
    "AttributeText1": "sample string 19",
    "AttributeText2": "sample string 20",
    "AttributeText3": "sample string 21",
    "AttributeText4": "sample string 22",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "AttributeDate1": "2025-04-04T05:14:13.7617469+00:00",
    "AttributeDate2": "2025-04-04T05:14:13.7617469+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfReviewOutletCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <ReviewOutletCreationRequest>
    <AccountHoldersName>sample string 17</AccountHoldersName>
    <Address>sample string 4</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-04-04T05:14:13.7617469+00:00</AttributeDate1>
    <AttributeDate2>2025-04-04T05:14:13.7617469+00:00</AttributeDate2>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeNumber3>1.1</AttributeNumber3>
    <AttributeNumber4>1.1</AttributeNumber4>
    <AttributeText1>sample string 19</AttributeText1>
    <AttributeText2>sample string 20</AttributeText2>
    <AttributeText3>sample string 21</AttributeText3>
    <AttributeText4>sample string 22</AttributeText4>
    <BankAccountNumber>sample string 16</BankAccountNumber>
    <City>sample string 10</City>
    <Email>sample string 13</Email>
    <GSTIN>sample string 12</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 18</IFSCCode>
    <MarketName>sample string 7</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OutletErpId>sample string 3</OutletErpId>
    <OutletName>sample string 2</OutletName>
    <OwnersName>sample string 9</OwnersName>
    <OwnersNo>sample string 11</OwnersNo>
    <PinCode>sample string 14</PinCode>
    <RequestId>1</RequestId>
    <Segmentation>Undefined</Segmentation>
    <ShopType>sample string 5</ShopType>
    <ShopTypeErpId>sample string 6</ShopTypeErpId>
    <State>sample string 8</State>
  </ReviewOutletCreationRequest>
  <ReviewOutletCreationRequest>
    <AccountHoldersName>sample string 17</AccountHoldersName>
    <Address>sample string 4</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-04-04T05:14:13.7617469+00:00</AttributeDate1>
    <AttributeDate2>2025-04-04T05:14:13.7617469+00:00</AttributeDate2>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeNumber3>1.1</AttributeNumber3>
    <AttributeNumber4>1.1</AttributeNumber4>
    <AttributeText1>sample string 19</AttributeText1>
    <AttributeText2>sample string 20</AttributeText2>
    <AttributeText3>sample string 21</AttributeText3>
    <AttributeText4>sample string 22</AttributeText4>
    <BankAccountNumber>sample string 16</BankAccountNumber>
    <City>sample string 10</City>
    <Email>sample string 13</Email>
    <GSTIN>sample string 12</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 18</IFSCCode>
    <MarketName>sample string 7</MarketName>
    <OutletChannel>Others</OutletChannel>
    <OutletErpId>sample string 3</OutletErpId>
    <OutletName>sample string 2</OutletName>
    <OwnersName>sample string 9</OwnersName>
    <OwnersNo>sample string 11</OwnersNo>
    <PinCode>sample string 14</PinCode>
    <RequestId>1</RequestId>
    <Segmentation>Undefined</Segmentation>
    <ShopType>sample string 5</ShopType>
    <ShopTypeErpId>sample string 6</ShopTypeErpId>
    <State>sample string 8</State>
  </ReviewOutletCreationRequest>
</ArrayOfReviewOutletCreationRequest>

Response Information

Resource Description

ApiResponse

Name	Description	Type	Additional 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>

POST api/V3/OutletAdditionRequest/review

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body