GET api/V3/PrimaryOrders/list?lastVisitId={lastVisitId}
Use this API to Get 100 Incremental Primary Orders
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
lastVisitId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Live data is available via this API
V3.PrimaryOrderModelName | Description | Type | Additional information |
---|---|---|---|
OrderId |
Visit unique Id |
integer |
None. |
DistributorGUID |
GUID of the distributor |
string |
None. |
DistributorErpId |
ErpId of Distributor for which Primary Order has been taken |
string |
None. |
DistributorType |
Type of Distributor - 1:Stockist, 2:Superstockist, 3:Sub Stockist |
integer |
None. |
EmployeeName |
Name of Employee who has taken Primary Order |
string |
None. |
EmpoyeeERPId |
Guid or ERP id of the Employee |
string |
None. |
EmployeeGUID |
Guid of Employee who has taken the Primary Order |
string |
Required Max length: 50 |
SuperStockistErpId |
SuperStockist ErpId for the Visit |
string |
None. |
OrderRemarks |
Additional remark added by the sales executive for Company. |
string |
None. |
Time |
Time of the Order |
date |
None. |
OrderType |
Order Type as selected by User at the Time of Primary order Booking |
string |
None. |
SyncTime |
Time of Syncing of Call to server |
date |
None. |
OrderDetails |
List of the booked items |
Collection of OrderDetails |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderId": 1, "DistributorGUID": "sample string 2", "DistributorErpId": "sample string 3", "DistributorType": 4, "EmployeeName": "sample string 5", "EmpoyeeERPId": "sample string 6", "EmployeeGUID": "sample string 7", "SuperStockistErpId": "sample string 8", "OrderRemarks": "sample string 9", "Time": "2025-04-04T05:14:10.7218505+00:00", "OrderType": "sample string 11", "SyncTime": "2025-04-04T05:14:10.7218505+00:00", "OrderDetails": [ { "ProductERPId": "sample string 1", "ProductName": "sample string 2", "Quantity": 3.1, "PTD": 1.1, "OriginalPTD": 1.1, "Discount": 1.1 }, { "ProductERPId": "sample string 1", "ProductName": "sample string 2", "Quantity": 3.1, "PTD": 1.1, "OriginalPTD": 1.1, "Discount": 1.1 } ] }
application/xml, text/xml
Sample:
<PrimaryOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models"> <DistributorErpId>sample string 3</DistributorErpId> <DistributorGUID>sample string 2</DistributorGUID> <DistributorType>4</DistributorType> <EmployeeGUID>sample string 7</EmployeeGUID> <EmployeeName>sample string 5</EmployeeName> <EmpoyeeERPId>sample string 6</EmpoyeeERPId> <OrderDetails> <OrderDetails> <Discount>1.1</Discount> <OriginalPTD>1.1</OriginalPTD> <PTD>1.1</PTD> <ProductERPId>sample string 1</ProductERPId> <ProductName>sample string 2</ProductName> <Quantity>3.1</Quantity> </OrderDetails> <OrderDetails> <Discount>1.1</Discount> <OriginalPTD>1.1</OriginalPTD> <PTD>1.1</PTD> <ProductERPId>sample string 1</ProductERPId> <ProductName>sample string 2</ProductName> <Quantity>3.1</Quantity> </OrderDetails> </OrderDetails> <OrderId>1</OrderId> <OrderRemarks>sample string 9</OrderRemarks> <OrderType>sample string 11</OrderType> <SuperStockistErpId>sample string 8</SuperStockistErpId> <SyncTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-04-04T05:14:10.7218505Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </SyncTime> <Time xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-04-04T05:14:10.7218505Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </Time> </PrimaryOrderModel>