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

Method: POST

Definitions

Field	Type	Description
programid	required integer	The `programid` to retrieve orders from.
number	response only integer	Order number for the requested order.
clientid	response only 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 for definitions.

Examples

Request XML

<orders>
 <programid>26490</programid>
</orders>

Response XML

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

Request JSON

{
 "orders":{
  "programid":"26490"
 }
}

Response JSON

{
 "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"
   }
  ]
 }
}