Get Order by Order Number
Endpoint: https://rest.virtualincentives.com/{version}/{format}/orders/{number}
Method: GET
Definitions
Field | Type | Description |
---|---|---|
number | response only integer | Order number generated upon successful creation. |
programid | response only integer | The programid that the order was placed under. |
clientid | response only integer | The clientid unique identifier for the order. |
status | response only string(50) | Order status of the requested order. Note: See Appendix A for definitions. |
id | response only string(50) | Unique account holder ID. |
firstname | response only string(50) | Account holder first name. |
lastname | response only string(50) | Account holder last name. |
address1 | response only string(100) | Account holder address line 1. |
address2 | response only string(50) | Account holder address line 2. |
city | response only string(50) | Account holder city. |
state | response only string(20) | Account holder state abbreviation (ISO 3166-2, subdivsion). |
zip | response only string(10) | Account holder zip code. |
country | response only string(2) | Account holder country abbreviation (ISO 3166-2). |
response only string(200) | Account holder email address. | |
sku | response only string(50) | Prepaid product SKU. |
amount | response only decimal | Denomination of the reward being issued. |
udf1 | response only string(100) | User Defined Field (UDF). |
udf2 | response only string(100) | User Defined Field (UDF). |
udf3 | response only string(1000) | User Defined Field (UDF). |
udf4 | response only string(1000) | User Defined Field (UDF). |
udf5 | response only string(1000) | User Defined Field (UDF). |
udf6 | response only string(4000) | User Defined Field (UDF). |
udf7 | response only string(4000) | User Defined Field (UDF). |
udf8 | response only string(4000) | User Defined Field (UDF). |
udf9 | response only string(4000) | User Defined Field (UDF). |
udf10 | response only string(4000) | User Defined Field (UDF). |
link | response only string(250) | Redemption link returned upon successful account creation. |
Examples
Response XML
<order>
<number>24681234</number>
<programid>26490</programid>
<clientid>56258125</clientid>
<status>completed</status>
<accounts>
<account>
<id>88523</id>
<firstname>John</firstname>
<lastname>Doe</lastname>
<email>[email protected]</email>
<sku>UVC-V-A06</sku>
<amount>10.00</amount>
<udf1></udf1>
<udf2></udf2>
<link>https://www.virtualrewardcenter.com/
Landing.aspx?id=88523&sid=093677BA-71FA-4137-B435-C17B1748E725</link>
</account>
<account>
<id>88524</id>
<firstname>Jane</firstname>
<lastname>Doe</lastname>
<email>[email protected]</email>
<sku>UVC-V-A06</sku>
<amount>25.00</amount>
<udf1></udf1>
<udf2></udf2>
<link>https://www.virtualrewardcenter.com/
Landing.aspx?id=88524&sid=0E6464C9-3D62-4C60-
8741-8BFA18EC187A</link>
</account>
</accounts>
</order>
Response JSON
{
"order":{
"programid":"26490",
"clientid":"56258125",
"number":"24681234",
"status":"completed",
"accounts":[
{
"id":"85425",
"firstname":"John",
"lastname":"Doe",
"email":"[email protected]",
"sku":"UVC-V-A06",
"amount":"10.00",
"udf1":"",
"udf2":"",
"link":"https://www.virtualrewardcenter.com/
Landing.aspx?id=85425&sid=b173b47f-228c
-4a97-8d68-e5835ca4ac66"
},
{
"id":"85426",
"firstname":"Jane",
"lastname":"Doe",
"email":"[email protected]",
"sku":"UVC-V-A06",
"amount":"25.00",
"udf1":"",
"udf2":"",
"link":"https://www.virtualrewardcenter.com/
Landing.aspx?id=85426&sid=1c2ce48f-8e27
-43a4-948a-e4a05e612dab"
}
]
}
}
Updated over 4 years ago