---
updatedAt: 2025-05-13T09:54:35.000Z
agentTools:
  projectIndex: https://developers.virtualincentives.com/llms.txt
---

# List Orders

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

**Method:** `POST`

# Definitions

| Field     | Type                             | Description                                                                           |
| --------- | -------------------------------- | ------------------------------------------------------------------------------------- |
| programid | **required**<br/>integer         | The `programid` to retrieve orders from.                                              |
| number    | **response only**<br/>integer    | Order number for the requested order.                                                 |
| clientid  | **response only**<br/>string(50) | The `clientid` client supplied unique identifier for the order.                       |
| status    | **response only** string(50)     | Order status of the requested order. See [Appendix A](https://developers.virtualincentives.com/docs/appendix)  for definitions. |

# Examples

## Request XML

```text
<orders>
 <programid>26490</programid>
</orders>
```

## Response XML

```text
<orders>
 <programid>26490</programid>
 <order>
  <number>24681234</number>
  <clientid>56258125</clientid>
  <status>completed</status>
 </order>
</orders>
```

## Request JSON

```text
{
 "orders":{
  "programid":"26490"
 }
}
```

## Response JSON

```text
{
 "orders":{
  "programid":"26490",
  "order":[
   {
    "number":"24686669",
    "clientid":"56258125",
    "status":"completed"
   },
   {
    "number":"24686670",
    "clientid":"56258126",
    "status":"completed"
   },
   {
    "number":"24686671",
    "clientid":"56258127",
    "status":"completed"
   },
   {
    "number":"24686672",
    "clientid":"56258128",
    "status":"pending"
   }
  ]
 }
}
```