Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients?ordernumber={ordernumber}

Method: GET

Definitions

Field	Type	Description
id	integer	The unique id for this recipient.
email	string(200)	Account holder email address.
udf1	string(100)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf2	string(100)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf3	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf4	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf5	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf6	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf7	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf8	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf9	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf10	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
ordernumber	integer	Order number that this recipient is related to.

Examples

XML Example

<response>
  <page>1</page>
  <more>false</more>
  <count>3</count>
  <total>3</total>

  <recipients>
    <recipient>
      <id>258155</id>
      <email>[email protected]</email>
      <udf1>Sample</udf1>
      <ordernumber>24690878</ordernumber>
    </recipient>

    <recipient>
      <id>258156</id>
      <email>[email protected]</email>
      <udf1>Sample</udf1>
      <ordernumber>24690878</ordernumber>
    </recipient>

    <recipient>
      <id>258157</id>
      <email>[email protected]</email>
      <udf1>Sample</udf1>
      <ordernumber>24690878</ordernumber>
    </recipient>
  </recipients>
</response>

JSON Example

{"response":{
"Page":1,
"More":false,
"Count":3,
"Total":3,

"Recipients":[
{"id":"258155",
"email":"[email protected]",
"udf1":"Sample",
"Ordernumber":"24690878"},

{"id":"258156",
"email":"[email protected]",
"udf1":"Sample",
"Ordernumber":"24690878"},

{"id":"258157",
"email":"[email protected]",
"udf1":"Sample",
"Ordernumber":"24690878"}]}}