GET api/V3/Visit/list
Lists all the visits. Use '$filter=VisitId gt {lastId}' to get the latest visits.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Top 100 visits are returned
Collection of V3.Visit| Name | Description | Type | Additional information |
|---|---|---|---|
| VisitGuid |
Visit unique Id |
globally unique identifier |
None. |
| VisitId |
Id of the visit |
integer |
None. |
| EmployeeName |
Name of the Employee. |
string |
None. |
| EmployeeGuid |
Employee unique Id |
globally unique identifier |
None. |
| DistributorErpId |
Distributor ErpId for the Visit |
string |
None. |
| EmpoyeeERPId |
id of the Employee. |
string |
None. |
| OutletName |
Outlet Name. |
string |
None. |
| OutletERPId |
Unique Id for the outlet/customer. |
string |
None. |
| BeatName |
BeatName |
string |
None. |
| BeatERPId |
Beat ERP Id |
string |
None. |
| Latitude |
Latitude if available |
decimal number |
None. |
| Longitude |
Longitude if available |
decimal number |
None. |
| Productive |
Is the visit productive. |
boolean |
None. |
| Valid |
If the sale valid. If the order is changed on a later stage it may change. |
boolean |
None. |
| NoSalesReason |
If there was no sales, the reason for that. |
string |
None. |
| RemarksManagement |
Additional remark added by the sales executive for management. |
string |
None. |
| RemarksDistributor |
Additional remark added by the sales executive for distributor. |
string |
None. |
| RemarksOther |
Other additional remark added by the sales executive. |
string |
None. |
| Time |
Time of the visit. |
date |
None. |
| SyncTime |
Time of Syncing of Call to server |
date |
None. |
| Discount |
Discount given on the Order |
decimal number |
None. |
| Sales |
List of the booked items |
Collection of V3.DetailedSale |
None. |
| OutOfTurn |
Was this Visit Out of turn (Not Scheduled for the Day) |
boolean |
None. |
| IsTelephonic |
Was this Telephonic Visit |
boolean |
None. |
| Outlet |
Outlet Details when ERPID for Outlet is Null |
V3.VisitOutlet |
None. |
| EmployeeLocalName | string |
None. |
|
| ExpectedDeliveryDate |
Expected Delivery Date if exists. |
date |
None. |
| SamplingProducts |
Sampling Products details |
Collection of V3.SamplingProduct |
None. |
| RouteErpId |
ErpId of Route |
string |
None. |
| CallStartTime |
Start time of Call |
date |
None. |
| CallEndTime |
End time of Call |
date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"VisitGuid": "dea12173-7809-42c9-8d4b-0a8bbbbe2913",
"VisitId": 2,
"EmployeeName": "sample string 3",
"EmployeeGuid": "e45ede23-cf09-431e-a09f-56892443df0a",
"DistributorErpId": "sample string 5",
"EmpoyeeERPId": "sample string 6",
"OutletName": "sample string 7",
"OutletERPId": "sample string 8",
"BeatName": "sample string 9",
"BeatERPId": "sample string 10",
"Latitude": 1.0,
"Longitude": 1.0,
"Productive": true,
"Valid": true,
"NoSalesReason": "sample string 11",
"RemarksManagement": "sample string 12",
"RemarksDistributor": "sample string 13",
"RemarksOther": "sample string 14",
"Time": "2026-01-07T07:08:44.9588335+00:00",
"SyncTime": "2026-01-07T07:08:44.9588335+00:00",
"Discount": 1.0,
"Sales": [
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"Variant": "sample string 3",
"Material": "sample string 4",
"Quantity": 5.1,
"Price": 1.1,
"OrderType": "sample string 6",
"Discount_Product": 1.1,
"Schemes": "sample string 7",
"SuggestiveQuantity": 1.1,
"VisitId": 8,
"AlternateCategory": "sample string 9",
"DistributorErpId": "sample string 10",
"OriginalPTR": 1.1,
"DistributorType": "sample string 11",
"ProductUnit": "sample string 12"
},
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"Variant": "sample string 3",
"Material": "sample string 4",
"Quantity": 5.1,
"Price": 1.1,
"OrderType": "sample string 6",
"Discount_Product": 1.1,
"Schemes": "sample string 7",
"SuggestiveQuantity": 1.1,
"VisitId": 8,
"AlternateCategory": "sample string 9",
"DistributorErpId": "sample string 10",
"OriginalPTR": 1.1,
"DistributorType": "sample string 11",
"ProductUnit": "sample string 12"
}
],
"OutOfTurn": true,
"IsTelephonic": true,
"Outlet": {
"OutletGuid": "sample string 1",
"Latitude": 1.0,
"Longitude": 1.0,
"OutletName": "sample string 2",
"ShopType": "sample string 3",
"ShopTypeErpId": "sample string 4",
"OutletChannel": "Others",
"ChannelErpId": "sample string 5",
"Address": "sample string 6",
"OwnersName": "sample string 7",
"OwnersNo": "sample string 8",
"TIN": "sample string 9",
"GSTIN": "sample string 10",
"PAN": "sample string 11",
"Aadhar": "sample string 12",
"Email": "sample string 13",
"PinCode": "sample string 14",
"MarketName": "sample string 15",
"City": "sample string 16",
"SubCity": "sample string 17",
"State": "sample string 18",
"GSTRegistered": true,
"BankAccountNumber": "sample string 20",
"AccountHoldersName": "sample string 21",
"IFSCCode": "sample string 22",
"AttributeText1": "sample string 23",
"AttributeText2": "sample string 24",
"AttributeText3": "sample string 25",
"SegmentationDisplayName": "sample string 26",
"Segmentation": 27,
"SegmentationErpId": "sample string 28"
},
"EmployeeLocalName": "sample string 19",
"ExpectedDeliveryDate": "2026-01-07T07:08:44.9588335+00:00",
"SamplingProducts": [
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"SamplingQuantity": 3
},
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"SamplingQuantity": 3
}
],
"RouteErpId": "sample string 20",
"CallStartTime": "2026-01-07T07:08:44.9588335+00:00",
"CallEndTime": "2026-01-07T07:08:44.9588335+00:00"
},
{
"VisitGuid": "dea12173-7809-42c9-8d4b-0a8bbbbe2913",
"VisitId": 2,
"EmployeeName": "sample string 3",
"EmployeeGuid": "e45ede23-cf09-431e-a09f-56892443df0a",
"DistributorErpId": "sample string 5",
"EmpoyeeERPId": "sample string 6",
"OutletName": "sample string 7",
"OutletERPId": "sample string 8",
"BeatName": "sample string 9",
"BeatERPId": "sample string 10",
"Latitude": 1.0,
"Longitude": 1.0,
"Productive": true,
"Valid": true,
"NoSalesReason": "sample string 11",
"RemarksManagement": "sample string 12",
"RemarksDistributor": "sample string 13",
"RemarksOther": "sample string 14",
"Time": "2026-01-07T07:08:44.9588335+00:00",
"SyncTime": "2026-01-07T07:08:44.9588335+00:00",
"Discount": 1.0,
"Sales": [
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"Variant": "sample string 3",
"Material": "sample string 4",
"Quantity": 5.1,
"Price": 1.1,
"OrderType": "sample string 6",
"Discount_Product": 1.1,
"Schemes": "sample string 7",
"SuggestiveQuantity": 1.1,
"VisitId": 8,
"AlternateCategory": "sample string 9",
"DistributorErpId": "sample string 10",
"OriginalPTR": 1.1,
"DistributorType": "sample string 11",
"ProductUnit": "sample string 12"
},
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"Variant": "sample string 3",
"Material": "sample string 4",
"Quantity": 5.1,
"Price": 1.1,
"OrderType": "sample string 6",
"Discount_Product": 1.1,
"Schemes": "sample string 7",
"SuggestiveQuantity": 1.1,
"VisitId": 8,
"AlternateCategory": "sample string 9",
"DistributorErpId": "sample string 10",
"OriginalPTR": 1.1,
"DistributorType": "sample string 11",
"ProductUnit": "sample string 12"
}
],
"OutOfTurn": true,
"IsTelephonic": true,
"Outlet": {
"OutletGuid": "sample string 1",
"Latitude": 1.0,
"Longitude": 1.0,
"OutletName": "sample string 2",
"ShopType": "sample string 3",
"ShopTypeErpId": "sample string 4",
"OutletChannel": "Others",
"ChannelErpId": "sample string 5",
"Address": "sample string 6",
"OwnersName": "sample string 7",
"OwnersNo": "sample string 8",
"TIN": "sample string 9",
"GSTIN": "sample string 10",
"PAN": "sample string 11",
"Aadhar": "sample string 12",
"Email": "sample string 13",
"PinCode": "sample string 14",
"MarketName": "sample string 15",
"City": "sample string 16",
"SubCity": "sample string 17",
"State": "sample string 18",
"GSTRegistered": true,
"BankAccountNumber": "sample string 20",
"AccountHoldersName": "sample string 21",
"IFSCCode": "sample string 22",
"AttributeText1": "sample string 23",
"AttributeText2": "sample string 24",
"AttributeText3": "sample string 25",
"SegmentationDisplayName": "sample string 26",
"Segmentation": 27,
"SegmentationErpId": "sample string 28"
},
"EmployeeLocalName": "sample string 19",
"ExpectedDeliveryDate": "2026-01-07T07:08:44.9588335+00:00",
"SamplingProducts": [
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"SamplingQuantity": 3
},
{
"ProductERPId": "sample string 1",
"ProductName": "sample string 2",
"SamplingQuantity": 3
}
],
"RouteErpId": "sample string 20",
"CallStartTime": "2026-01-07T07:08:44.9588335+00:00",
"CallEndTime": "2026-01-07T07:08:44.9588335+00:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfVisit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
<Visit>
<BeatERPId>sample string 10</BeatERPId>
<BeatName>sample string 9</BeatName>
<CallEndTime>2026-01-07T07:08:44.9588335+00:00</CallEndTime>
<CallStartTime>2026-01-07T07:08:44.9588335+00:00</CallStartTime>
<Discount>1</Discount>
<EmployeeGuid>e45ede23-cf09-431e-a09f-56892443df0a</EmployeeGuid>
<EmployeeName>sample string 3</EmployeeName>
<EmpoyeeERPId>sample string 6</EmpoyeeERPId>
<ExpectedDeliveryDate>2026-01-07T07:08:44.9588335+00:00</ExpectedDeliveryDate>
<IsTelephonic>true</IsTelephonic>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<NoSalesReason>sample string 11</NoSalesReason>
<OutOfTurn>true</OutOfTurn>
<Outlet>
<Aadhar>sample string 12</Aadhar>
<AccountHoldersName>sample string 21</AccountHoldersName>
<Address>sample string 6</Address>
<AttributeText1>sample string 23</AttributeText1>
<AttributeText2>sample string 24</AttributeText2>
<AttributeText3>sample string 25</AttributeText3>
<BankAccountNumber>sample string 20</BankAccountNumber>
<ChannelErpId>sample string 5</ChannelErpId>
<City>sample string 16</City>
<Email>sample string 13</Email>
<GSTIN>sample string 10</GSTIN>
<GSTRegistered>true</GSTRegistered>
<IFSCCode>sample string 22</IFSCCode>
<MarketName>sample string 15</MarketName>
<OutletChannel>Others</OutletChannel>
<OutletName>sample string 2</OutletName>
<OwnersName>sample string 7</OwnersName>
<OwnersNo>sample string 8</OwnersNo>
<PAN>sample string 11</PAN>
<PinCode>sample string 14</PinCode>
<Segmentation>27</Segmentation>
<SegmentationDisplayName>sample string 26</SegmentationDisplayName>
<SegmentationErpId>sample string 28</SegmentationErpId>
<ShopType>sample string 3</ShopType>
<ShopTypeErpId>sample string 4</ShopTypeErpId>
<State>sample string 18</State>
<SubCity>sample string 17</SubCity>
<TIN>sample string 9</TIN>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<OutletGuid>sample string 1</OutletGuid>
</Outlet>
<OutletERPId>sample string 8</OutletERPId>
<OutletName>sample string 7</OutletName>
<Productive>true</Productive>
<RemarksDistributor>sample string 13</RemarksDistributor>
<RemarksManagement>sample string 12</RemarksManagement>
<RemarksOther>sample string 14</RemarksOther>
<RouteErpId>sample string 20</RouteErpId>
<Sales>
<DetailedSale>
<AlternateCategory>sample string 9</AlternateCategory>
<Discount_Product>1.1</Discount_Product>
<DistributorErpId>sample string 10</DistributorErpId>
<DistributorType>sample string 11</DistributorType>
<OrderType>sample string 6</OrderType>
<OriginalPTR>1.1</OriginalPTR>
<Price>1.1</Price>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<ProductUnit>sample string 12</ProductUnit>
<Quantity>5.1</Quantity>
<Schemes>sample string 7</Schemes>
<SuggestiveQuantity>1.1</SuggestiveQuantity>
<Variant>sample string 3</Variant>
<VisitId>8</VisitId>
</DetailedSale>
<DetailedSale>
<AlternateCategory>sample string 9</AlternateCategory>
<Discount_Product>1.1</Discount_Product>
<DistributorErpId>sample string 10</DistributorErpId>
<DistributorType>sample string 11</DistributorType>
<OrderType>sample string 6</OrderType>
<OriginalPTR>1.1</OriginalPTR>
<Price>1.1</Price>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<ProductUnit>sample string 12</ProductUnit>
<Quantity>5.1</Quantity>
<Schemes>sample string 7</Schemes>
<SuggestiveQuantity>1.1</SuggestiveQuantity>
<Variant>sample string 3</Variant>
<VisitId>8</VisitId>
</DetailedSale>
</Sales>
<SamplingProducts>
<SamplingProduct>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<SamplingQuantity>3</SamplingQuantity>
</SamplingProduct>
<SamplingProduct>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<SamplingQuantity>3</SamplingQuantity>
</SamplingProduct>
</SamplingProducts>
<SyncTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-01-07T07:08:44.9588335Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</SyncTime>
<Time xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-01-07T07:08:44.9588335Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</Time>
<Valid>true</Valid>
<VisitGuid>dea12173-7809-42c9-8d4b-0a8bbbbe2913</VisitGuid>
<VisitId>2</VisitId>
</Visit>
<Visit>
<BeatERPId>sample string 10</BeatERPId>
<BeatName>sample string 9</BeatName>
<CallEndTime>2026-01-07T07:08:44.9588335+00:00</CallEndTime>
<CallStartTime>2026-01-07T07:08:44.9588335+00:00</CallStartTime>
<Discount>1</Discount>
<EmployeeGuid>e45ede23-cf09-431e-a09f-56892443df0a</EmployeeGuid>
<EmployeeName>sample string 3</EmployeeName>
<EmpoyeeERPId>sample string 6</EmpoyeeERPId>
<ExpectedDeliveryDate>2026-01-07T07:08:44.9588335+00:00</ExpectedDeliveryDate>
<IsTelephonic>true</IsTelephonic>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<NoSalesReason>sample string 11</NoSalesReason>
<OutOfTurn>true</OutOfTurn>
<Outlet>
<Aadhar>sample string 12</Aadhar>
<AccountHoldersName>sample string 21</AccountHoldersName>
<Address>sample string 6</Address>
<AttributeText1>sample string 23</AttributeText1>
<AttributeText2>sample string 24</AttributeText2>
<AttributeText3>sample string 25</AttributeText3>
<BankAccountNumber>sample string 20</BankAccountNumber>
<ChannelErpId>sample string 5</ChannelErpId>
<City>sample string 16</City>
<Email>sample string 13</Email>
<GSTIN>sample string 10</GSTIN>
<GSTRegistered>true</GSTRegistered>
<IFSCCode>sample string 22</IFSCCode>
<MarketName>sample string 15</MarketName>
<OutletChannel>Others</OutletChannel>
<OutletName>sample string 2</OutletName>
<OwnersName>sample string 7</OwnersName>
<OwnersNo>sample string 8</OwnersNo>
<PAN>sample string 11</PAN>
<PinCode>sample string 14</PinCode>
<Segmentation>27</Segmentation>
<SegmentationDisplayName>sample string 26</SegmentationDisplayName>
<SegmentationErpId>sample string 28</SegmentationErpId>
<ShopType>sample string 3</ShopType>
<ShopTypeErpId>sample string 4</ShopTypeErpId>
<State>sample string 18</State>
<SubCity>sample string 17</SubCity>
<TIN>sample string 9</TIN>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<OutletGuid>sample string 1</OutletGuid>
</Outlet>
<OutletERPId>sample string 8</OutletERPId>
<OutletName>sample string 7</OutletName>
<Productive>true</Productive>
<RemarksDistributor>sample string 13</RemarksDistributor>
<RemarksManagement>sample string 12</RemarksManagement>
<RemarksOther>sample string 14</RemarksOther>
<RouteErpId>sample string 20</RouteErpId>
<Sales>
<DetailedSale>
<AlternateCategory>sample string 9</AlternateCategory>
<Discount_Product>1.1</Discount_Product>
<DistributorErpId>sample string 10</DistributorErpId>
<DistributorType>sample string 11</DistributorType>
<OrderType>sample string 6</OrderType>
<OriginalPTR>1.1</OriginalPTR>
<Price>1.1</Price>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<ProductUnit>sample string 12</ProductUnit>
<Quantity>5.1</Quantity>
<Schemes>sample string 7</Schemes>
<SuggestiveQuantity>1.1</SuggestiveQuantity>
<Variant>sample string 3</Variant>
<VisitId>8</VisitId>
</DetailedSale>
<DetailedSale>
<AlternateCategory>sample string 9</AlternateCategory>
<Discount_Product>1.1</Discount_Product>
<DistributorErpId>sample string 10</DistributorErpId>
<DistributorType>sample string 11</DistributorType>
<OrderType>sample string 6</OrderType>
<OriginalPTR>1.1</OriginalPTR>
<Price>1.1</Price>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<ProductUnit>sample string 12</ProductUnit>
<Quantity>5.1</Quantity>
<Schemes>sample string 7</Schemes>
<SuggestiveQuantity>1.1</SuggestiveQuantity>
<Variant>sample string 3</Variant>
<VisitId>8</VisitId>
</DetailedSale>
</Sales>
<SamplingProducts>
<SamplingProduct>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<SamplingQuantity>3</SamplingQuantity>
</SamplingProduct>
<SamplingProduct>
<ProductERPId>sample string 1</ProductERPId>
<ProductName>sample string 2</ProductName>
<SamplingQuantity>3</SamplingQuantity>
</SamplingProduct>
</SamplingProducts>
<SyncTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-01-07T07:08:44.9588335Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</SyncTime>
<Time xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-01-07T07:08:44.9588335Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</Time>
<Valid>true</Valid>
<VisitGuid>dea12173-7809-42c9-8d4b-0a8bbbbe2913</VisitGuid>
<VisitId>2</VisitId>
</Visit>
</ArrayOfVisit>