Rewards program API

What is an API?

Rewards API makes it easier than ever before to reward your employees, market research panellists, partners and consumers around the world.

Our suite of secure RESTful APIs allow you to connect to our platform in many ways including:

Generate reward codes on demand – include country and language restrictions
Automatically distribute reward codes to individuals and the world
Numerous reward data lookups, filters and customer service requests
Import and host our reward catalogs and publish live delivery data
Automatically top up values

See examples of our API suite below and get in touch to try it out.

API illustration showing data from client server to Ovation server. With rewards from Ovation server to client server

Remove reward administration at your site
Reduce internal cost
Increase service levels and speed of delivery
Access a wide range of digital rewards fulfilled in real-time
Secure and trusted systems with ISO27001 certification - hosted in the EU

Simple rewards integration

Our award-winning API technology enables our rewards to be easily integrated with your existing systems. The implementation process couldn't be more straightforward.

With tailor-made solutions to fit your budget and plan, it’s quick to connect with our international rewards catalogue and improve your programme today.

Perfect for market research rewards and loyalty campaigns.

RESTful API Documentation

UV Codes

Manage your customers "Universal Voucher" reward codes

Description

Create a UV reward code against one of your schemes we have set up for you.

Implementation Notes

The language (required) must exist in your scheme.
The country if set must exist in your scheme.
If "IsSingleCountry" is true you must also include a "countryCode".
If "SendEmail" is true you must include a Recipient model.
ValidFrom and ValidTo will only be taken into account if you have permissions to set these, otherwise the system defaults are used.

Error List

UNKNOWN_SCHEME: Unknown scheme
INVALID_EMAIL: Invalid email
UNKNOWN_CURRENCY: Unknown currency
UNKNOWN_COUNTRY: Unknown country
UNKNOWN_LANGUAGE: Unknown language

Response Class (Status 201)

Created

Request

CodeCreateApiModel {
‍ValidFrom (string, optional): Date that the code can be first used in the shop,
‍ValidTo (string, optional): Date that the code is no longer valid,
‍SendEmail (boolean): Your scheme that the code is associated with,
‍Recipient (CodeRecipientApiModel, optional): The recipient of the code. This is required if SendEmail is set to true,
‍SchemeId (integer),
‍Value (number): The value on the code,
‍CurrencyCode (string): The currency the code is be created in,
‍CountryCode (string, optional): The default country the recipient will use in the shop. This is required when creating a single country code.,
‍LanguageCode (string): This is the language choice for emails and the shop. If you scheme has multiple languages the recipient will be able to change this once they are shopping,
‍IsSingleCountry (boolean): This sets whether the recipient can redeem the code in one country or all the countries available in the scheme.,
‍ClaimIdentifier (string): Your unique order reference for this code
}
CodeRecipientApiModel {
‍FirstName (string, optional),
‍LastName (string, optional),
‍Email (string, optional)
}

{
"ValidFrom": "2022-01-24T11:50:00.548Z",
"ValidTo": "2022-01-24T11:50:00.548Z",
"SendEmail": true,
"Recipient": {
 "FirstName": "string",
 "LastName": "string",
 "Email": "string"
 },
"SchemeId": 0,
"Value": 0,
"CurrencyCode": "string",
"CountryCode": "string",
"LanguageCode": "string",
"IsSingleCountry": true,
"ClaimIdentifier": "string"
}

Response

CodeInfoApiModel {
‍Id (integer, optional): The your unique system reference for this code,
‍Topups (Array[TopupDetailsApiModel], optional): A list of adjustments made to the code.,
‍Code (string, optional): The recipients reward code,
‍Url (string, optional): The Url that will take the recipient straight into the shop,
‍SchemeId (integer),
‍Value (number): The value on the code,
‍CurrencyCode (string): The currency the code is be created in,
‍CountryCode (string, optional): The default country the recipient will use in the shop. This is required when creating a single country code.,
‍LanguageCode (string): This is the language choice for emails and the shop. If you scheme has multiple languages the recipient will be able to change this once they are shopping,
‍IsSingleCountry (boolean): This sets whether the recipient can redeem the code in one country or all the countries available in the scheme.,
‍ClaimIdentifier (string): Your unique order reference for this code
}
TopupDetailsApiModel {
‍ValidFrom (string, optional),
‍ValidTo (string, optional),ClaimId (string, optional),
‍Value (number, optional),
‍Reason (string, optional),
‍SendEmails (boolean, optional)
}

{
"Id": 0,
"Topups": [
 {
 "ValidFrom": "2022-01-24T11:50:00.543Z",
 "ValidTo": "2022-01-24T11:50:00.543Z",
 "ClaimId": "string",
 "Value": 0,
 "Reason": "string",
 "SendEmails": true
 }
],
"Code": "string",
"Url": "string",
"SchemeId": 0,
"Value": 0,
"CurrencyCode": "string",
"CountryCode": "string",
"LanguageCode": "string",
"IsSingleCountry": true,
"ClaimIdentifier": "string"
}

Try it out

Proven results with loyalty platform

Read our case study to find out how Ovation's global rewards catalogue API was able to help SSI.

Read the case study View infographic