List Orders

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

Method: POST

Definitions

FieldTypeDescription
programidrequired
integer
The programid to retrieve orders from.
numberresponse only
integer
Order number for the requested order.
clientidresponse only
string(50)
The clientid client supplied unique identifier for the order.
statusresponse 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>
 lt;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"
   }
  ]
 }
}

© Copyright 2019. All other rights reserved.