GET api/orders/search?patientExternalId={patientExternalId}&locationExternalId={locationExternalId}&externalId={externalId}&utcCreationDate={utcCreationDate}&utcPickupDate={utcPickupDate}&patientBalance={patientBalance}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of orders.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientExternalId

Return orders with patient external ID containing this parameter's value.

 string

None.
locationExternalId

Return orders with location external ID containing this parameter's value.

 string

None.
externalId

Order's unique ID on integrating system.

 string

Default value is empty string ("")
utcCreationDate

Return orders with creation date containing this parameter's value.

 date

None.
utcPickupDate

Return orders with pickup date containing this parameter's value.

 date

None.
patientBalance

Return orders with patient balance containing this parameter's value.

 decimal number

None.
page

Page number requested (search results are paginated).

 integer

Default value is 1
itemsPerPage

Items to return on each page. See page parameter above.

 integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfOrderModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.
ItemsPerPage

integer

None.
CurrentPage

integer

None.
TotalPages

integer

None.
FirstRowOnPage

integer

None.
LastRowOnPage

integer

None.
Rows

Collection of OrderModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "created": "2026-05-29T16:59:21.4572244+00:00",
      "pickupDate": "2026-05-29T16:59:21.4572244+00:00",
      "patientExternalId": "sample string 2",
      "locationExternalId": "sample string 3",
      "physicianExternalId": "sample string 4",
      "userExternalId": "sample string 5",
      "orderStatusExternalId": "sample string 6",
      "orderBalance": 7.0,
      "patientBalance": 8.0,
      "receiptNote": "sample string 9",
      "type": "sample string 10",
      "orderDetails": [
        {
          "orderDetailExternalId": "sample string 1",
          "productDescription": "sample string 2",
          "quantity": 3,
          "retailPrice": 1.0,
          "unitPrice": 4.0,
          "tax1": 5.0,
          "tax2": 6.0
        },
        {
          "orderDetailExternalId": "sample string 1",
          "productDescription": "sample string 2",
          "quantity": 3,
          "retailPrice": 1.0,
          "unitPrice": 4.0,
          "tax1": 5.0,
          "tax2": 6.0
        }
      ],
      "id": "877084c0-1848-47cc-974b-50df708e3c7c",
      "externalId": "sample string 12"
    },
    {
      "created": "2026-05-29T16:59:21.4572244+00:00",
      "pickupDate": "2026-05-29T16:59:21.4572244+00:00",
      "patientExternalId": "sample string 2",
      "locationExternalId": "sample string 3",
      "physicianExternalId": "sample string 4",
      "userExternalId": "sample string 5",
      "orderStatusExternalId": "sample string 6",
      "orderBalance": 7.0,
      "patientBalance": 8.0,
      "receiptNote": "sample string 9",
      "type": "sample string 10",
      "orderDetails": [
        {
          "orderDetailExternalId": "sample string 1",
          "productDescription": "sample string 2",
          "quantity": 3,
          "retailPrice": 1.0,
          "unitPrice": 4.0,
          "tax1": 5.0,
          "tax2": 6.0
        },
        {
          "orderDetailExternalId": "sample string 1",
          "productDescription": "sample string 2",
          "quantity": 3,
          "retailPrice": 1.0,
          "unitPrice": 4.0,
          "tax1": 5.0,
          "tax2": 6.0
        }
      ],
      "id": "877084c0-1848-47cc-974b-50df708e3c7c",
      "externalId": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample: 
<ListModelOfOrderModelywYO7qaI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Orders">
    <d2p1:OrderModel>
      <ExternalId>sample string 12</ExternalId>
      <Id>877084c0-1848-47cc-974b-50df708e3c7c</Id>
      <d2p1:Created>2026-05-29T16:59:21.4572244+00:00</d2p1:Created>
      <d2p1:LocationExternalId>sample string 3</d2p1:LocationExternalId>
      <d2p1:OrderBalance>7</d2p1:OrderBalance>
      <d2p1:OrderDetails>
        <d2p1:OrderDetailModel>
          <d2p1:OrderDetailExternalId>sample string 1</d2p1:OrderDetailExternalId>
          <d2p1:ProductDescription>sample string 2</d2p1:ProductDescription>
          <d2p1:Quantity>3</d2p1:Quantity>
          <d2p1:RetailPrice>1</d2p1:RetailPrice>
          <d2p1:Tax1>5</d2p1:Tax1>
          <d2p1:Tax2>6</d2p1:Tax2>
          <d2p1:UnitPrice>4</d2p1:UnitPrice>
        </d2p1:OrderDetailModel>
        <d2p1:OrderDetailModel>
          <d2p1:OrderDetailExternalId>sample string 1</d2p1:OrderDetailExternalId>
          <d2p1:ProductDescription>sample string 2</d2p1:ProductDescription>
          <d2p1:Quantity>3</d2p1:Quantity>
          <d2p1:RetailPrice>1</d2p1:RetailPrice>
          <d2p1:Tax1>5</d2p1:Tax1>
          <d2p1:Tax2>6</d2p1:Tax2>
          <d2p1:UnitPrice>4</d2p1:UnitPrice>
        </d2p1:OrderDetailModel>
      </d2p1:OrderDetails>
      <d2p1:OrderStatusExternalId>sample string 6</d2p1:OrderStatusExternalId>
      <d2p1:PatientBalance>8</d2p1:PatientBalance>
      <d2p1:PatientExternalId>sample string 2</d2p1:PatientExternalId>
      <d2p1:PhysicianExternalId>sample string 4</d2p1:PhysicianExternalId>
      <d2p1:PickupDate>2026-05-29T16:59:21.4572244+00:00</d2p1:PickupDate>
      <d2p1:ReceiptNote>sample string 9</d2p1:ReceiptNote>
      <d2p1:Type>sample string 10</d2p1:Type>
      <d2p1:UserExternalId>sample string 5</d2p1:UserExternalId>
    </d2p1:OrderModel>
    <d2p1:OrderModel>
      <ExternalId>sample string 12</ExternalId>
      <Id>877084c0-1848-47cc-974b-50df708e3c7c</Id>
      <d2p1:Created>2026-05-29T16:59:21.4572244+00:00</d2p1:Created>
      <d2p1:LocationExternalId>sample string 3</d2p1:LocationExternalId>
      <d2p1:OrderBalance>7</d2p1:OrderBalance>
      <d2p1:OrderDetails>
        <d2p1:OrderDetailModel>
          <d2p1:OrderDetailExternalId>sample string 1</d2p1:OrderDetailExternalId>
          <d2p1:ProductDescription>sample string 2</d2p1:ProductDescription>
          <d2p1:Quantity>3</d2p1:Quantity>
          <d2p1:RetailPrice>1</d2p1:RetailPrice>
          <d2p1:Tax1>5</d2p1:Tax1>
          <d2p1:Tax2>6</d2p1:Tax2>
          <d2p1:UnitPrice>4</d2p1:UnitPrice>
        </d2p1:OrderDetailModel>
        <d2p1:OrderDetailModel>
          <d2p1:OrderDetailExternalId>sample string 1</d2p1:OrderDetailExternalId>
          <d2p1:ProductDescription>sample string 2</d2p1:ProductDescription>
          <d2p1:Quantity>3</d2p1:Quantity>
          <d2p1:RetailPrice>1</d2p1:RetailPrice>
          <d2p1:Tax1>5</d2p1:Tax1>
          <d2p1:Tax2>6</d2p1:Tax2>
          <d2p1:UnitPrice>4</d2p1:UnitPrice>
        </d2p1:OrderDetailModel>
      </d2p1:OrderDetails>
      <d2p1:OrderStatusExternalId>sample string 6</d2p1:OrderStatusExternalId>
      <d2p1:PatientBalance>8</d2p1:PatientBalance>
      <d2p1:PatientExternalId>sample string 2</d2p1:PatientExternalId>
      <d2p1:PhysicianExternalId>sample string 4</d2p1:PhysicianExternalId>
      <d2p1:PickupDate>2026-05-29T16:59:21.4572244+00:00</d2p1:PickupDate>
      <d2p1:ReceiptNote>sample string 9</d2p1:ReceiptNote>
      <d2p1:Type>sample string 10</d2p1:Type>
      <d2p1:UserExternalId>sample string 5</d2p1:UserExternalId>
    </d2p1:OrderModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfOrderModelywYO7qaI>