---
updatedAt: 2026-09-08T22:06:57.000Z
agentTools:
  projectIndex: https://developers.virtualincentives.com/llms.txt
---

# Get Orders

**Endpoint:** `https://rest.virtualincentives.com{version}/{format}/orders`

**Method:** `GET`

# Filtering Orders by Program ID, Client ID, and Date

You can filter the orders through the query string parameters using any combination of [Program ID](https://developers.virtualincentives.com/docs/get-orders-by-program-id-2), [Client ID](https://developers.virtualincentives.com/docs/get-orders-by-client-id-2), and [Date](https://developers.virtualincentives.com/docs/get-orders-by-date-2). See these specific pages for more information.

# Definitions

| Field     | Type                           | Description                                                                                                    |
| --------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| programid | integer                        | The `programid` that the order was placed under.                                                               |
| date      | datetime                       | Order date for the request order. Format: MM/dd/yyyy HH:mm                                                     |
| status    | string(50)                     | Order status for the requested order.<br /><br />**Note:** See [Appendix A](https://developers.virtualincentives.com/docs/appendices-1) for definitions. |
| number    | **response only**<br />integer | Order number generated upon successful creation.                                                               |
| clientid  | integer                        | Client supplied unique identifier for the order.                                                               |

# Examples

## Response XML

```text
<orders>
  <order>
    <number>27213905</number>
    <date>04/17/2018 18:10</date>
    <programid>26154</programid>
    <clientid />
    <status>completed</status>
  </order>
  <order>
    <number>27213909</number>
    <date>04/17/2018 18:13</date>
    <programid>26154</programid>
    <clientid />
    <status>completed</status>
  </order>
  <order>
    <number>27285729</number>
    <date>05/10/2018 15:07</date>
    <programid>26154</programid>
    <clientid />
    <status>completed</status>
  </order>
</orders>
```

## Response JSON

```text
{
  "orders": {
    "order": [
      {
        "number": "27213905",
        "date": "04/17/2018 18:10",
        "programid": "26154",
        "clientid": "",
        "status": "completed"
      },
      {
        "number": "27213909",
        "date": "04/17/2018 18:13",
        "programid": "26154",
        "clientid": "",
        "status": "completed"
      },
      {
        "number": "27285729",
        "date": "05/10/2018 15:07",
        "programid": "26154",
        "clientid": "",
        "status": "completed"
      }
    ]
  }
}
```