Get Order by Order Number

Endpoint: https://rest.virtualincentives.com/{version}/{format}/orders/{number}

Method: GET

Definitions

FieldTypeDescription
programidrequired
integer
The programid serves an identifier that determines the funding account and branding to use for this request.
clientidrequired
string(50)
Client provided unique identifier for the request. This field also serves as a duplicate transaction check. After a successful transaction is placed using this identifier, all subsequent requests using the same identifier are rejected as duplicate orders.
fulfillmentrequired
string(50)
Allowed values are bulk or individual.
For virtual rewards:
- bulk returns the reward link in the API response.
- individual rewards are emailed directly to the recipient.

For physical rewards:
- bulk rewards are shipped via courier to a single address specified in the shipping object.
- individual rewards are sent via USPS directly to the recipient.
shippingobjectThis field is required only for bulk physical rewards. It contains the address which the courier will deliver the bulk order.
shipping.companystring(100)The name of your company.
shipping.attentionstring(100)The name of the person within your organization who should receive the bulk package.
shipping.address1string(100)Courier address line 1.
shipping.address2string(50)Courier address line 2.
shipping.citystring(50)Courier city line.
shipping.statestring(20)Courier state abbreviation (ISO 3166-2, subdivision)..
string.zipstring(50)Courier zip code line.
string.countrystring(2)Courier country abbreviation line (ISO 3166-2).
emailrequired
string(200)
Account holder email address.

Note: For anonymous rewards, please use a generic support email address, such as [email protected]
firstnamerequired
string(50)
Account holder first name.

Note: This field is displayed in the email and VRC salutation. For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
lastnamerequired
string(50)
Account holder last name.

Note: For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
skurequired
string(50)
Virtual prepaid product SKU requested.

Note: SKU document delivered separately.
amountrequired
decimal
The amount Denomination of the reward being issued.

Note: Currency is determined by the SKU requested.
address1string(100)Account holder address line 1.
address2string(50)Account holder address line 2.
citystring(50)Account holder city.
statestring(20)Account holder state abbreviation (ISO 3166-2, subdivision).
zipstring(10)Account holder zip code.
countrystring(2)Account holder country abbreviation (ISO 3166-2).
udf1string(100)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf2string(100)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf3string(1000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf4string(1000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf5string(1000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf6string(4000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf7string(4000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf8string(4000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf9string(4000)Additional User Defined field.

Note: See ‘udf1’ for definition.
udf10string(4000)Additional User Defined field.

Note: See ‘udf1’ for definition.
idresponse only
integer
Unique Account Holder ID.
numberresponse only
integer
Order number generated upon successful creation.
statusresponse only
string(50)
Order status of the requested order. See Appendix A for definitions.
linkresponse only
string(250)
Redemption link returned upon successful account creation.

Examples

Response XML

<order>
  <programid>27155</programid>
  <clientid>9749362</clientid>
  <fulfillment>individual</fulfillment>
  <number>24693509</number>
  <status>completed</status>
  <accounts>
    <account>
      <id>261343</id>
      <firstname>Reward</firstname>
      <lastname>Recipient</lastname>
      <email>[email protected]</email>
      <sku>UVC-V-P18</sku>
      <currency>USD</currency>
      <amount>10.00</amount>
      <udf1></udf1>
      <udf2></udf2>
   <link>https://www2.virtualrewardcenter.com/landing?id=261343&amp;sid=177D7768-26DD-7916-515C-25250AC82B74</link>
    </account>
    <account>
      <id>261344</id>
      <firstname>Jane</firstname>
      <lastname>Doe</lastname>
      <email>[email protected]</email>
      <sku>UVC-V-P18</sku>
      <currency>USD</currency>
      <amount>25.00</amount>
       <udf1></udf1>
       <udf2></udf2>            
      <link>https://www2.virtualrewardcenter.com/landing?id=261344&amp;sid=CC4B5F2A-3D8B-96D2-C139-67E5A45BFD58</link>                    
    </account>
  </accounts>
</order>

Response JSON

{
"Order":{
"Programid":"27155",
"Clientid":"9749362",
"Fulfillment":"individual",
"Number":"24693509",
"Status":"completed",
"Accounts":[
{
"Id":"261343",
"firstname":"Reward",
"lastname":"Recipient",
"email":"[email protected]",
"sku":"UVC-V-P18",
"currency":"USD",
"Amount":"10.00",
"udf1":"",
"udf2":"",
"link":"https://www2.virtualrewardcenter.com/landing?id=261343&sid=177D7768-26DD-7916-515C-25250AC82B74"
},
{
"Id":"261344",
"firstname":"Jane",
"lastname":"Doe",
"email":"[email protected]",
"sku":"UVC-V-P18",
"currency":"USD",
"Amount":"25.00",
"udf1":"",
"udf2":"",
"link":"https://www2.virtualrewardcenter.com/landing?id=261344&sid=CC4B5F2A-3D8B-96D2-C139-67E5A45BFD58"
}
]
}
}