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, Client ID, and Date. 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. Note: See Appendix A for definitions. |
number | response only integer | Order number generated upon successful creation. |
clientid | integer | Client supplied unique identifier for the order. |
Examples
Response XML
<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
{
"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"
}
]
}
}
Updated almost 4 years ago