GET api/V3/PrimaryOrders/list

Lists all the Prinary Orders. Use '$filter=OrderId gt {lastId}' to get the latest Orders.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Top 100 visits are returned

Collection of V3.PrimaryOrder
NameDescriptionTypeAdditional information
OrderId

Id of the PrimaryOrder

 integer

None.
DistributorErpId

Distributor ErpId for the Visit

 string

None.
EmpoyeeERPId

id of the Employee.

 string

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

Time of Syncing of Call to server

 date

None.
OrderDiscount

Discount on the Order

 decimal number

None.
OrderDetails

List of the booked items

 Collection of V3.DetailedPrimaryOrder

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OrderId": 1,
    "DistributorErpId": "sample string 2",
    "EmpoyeeERPId": "sample string 3",
    "SuperStockistErpId": "sample string 4",
    "OrderRemarks": "sample string 5",
    "Time": "2026-01-07T07:09:45.8206965+00:00",
    "SyncTime": "2026-01-07T07:09:45.8206965+00:00",
    "OrderDiscount": 1.0,
    "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
      }
    ]
  },
  {
    "OrderId": 1,
    "DistributorErpId": "sample string 2",
    "EmpoyeeERPId": "sample string 3",
    "SuperStockistErpId": "sample string 4",
    "OrderRemarks": "sample string 5",
    "Time": "2026-01-07T07:09:45.8206965+00:00",
    "SyncTime": "2026-01-07T07:09:45.8206965+00:00",
    "OrderDiscount": 1.0,
    "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: 
<ArrayOfDetailedPrimaryOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <DetailedPrimaryOrder>
    <DistributorErpId>sample string 2</DistributorErpId>
    <EmpoyeeERPId>sample string 3</EmpoyeeERPId>
    <OrderDetails>
      <DetailedPrimaryOrderItem>
        <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>
      </DetailedPrimaryOrderItem>
      <DetailedPrimaryOrderItem>
        <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>
      </DetailedPrimaryOrderItem>
    </OrderDetails>
    <OrderId>1</OrderId>
    <OrderRemarks>sample string 5</OrderRemarks>
    <SuperStockistErpId>sample string 4</SuperStockistErpId>
    <SyncTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-01-07T07:09:45.8206965Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </SyncTime>
    <Time xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-01-07T07:09:45.8206965Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Time>
  </DetailedPrimaryOrder>
  <DetailedPrimaryOrder>
    <DistributorErpId>sample string 2</DistributorErpId>
    <EmpoyeeERPId>sample string 3</EmpoyeeERPId>
    <OrderDetails>
      <DetailedPrimaryOrderItem>
        <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>
      </DetailedPrimaryOrderItem>
      <DetailedPrimaryOrderItem>
        <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>
      </DetailedPrimaryOrderItem>
    </OrderDetails>
    <OrderId>1</OrderId>
    <OrderRemarks>sample string 5</OrderRemarks>
    <SuperStockistErpId>sample string 4</SuperStockistErpId>
    <SyncTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-01-07T07:09:45.8206965Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </SyncTime>
    <Time xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-01-07T07:09:45.8206965Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Time>
  </DetailedPrimaryOrder>
</ArrayOfDetailedPrimaryOrder>