Offers API - Finding out about promotions
The Uniqodo Distributor APIs provides code publishing distributors with a way of building Uniqodo codes in their web site or application. Every distributor is setup with an API key providing access to two different RESTful APIs, the Offer API and the Code API.
This documentation explains the the Offer API which provides publishing distributors with a full list of the code triggered offers that merchants have given them permission to promote. The Offer API doesn’t provide the actual codes to provide to shoppers, but only the information about the offer or discount.
The Code API provides the actual codes for publisher distributors to give to shoppers. When a distributor wishes to give a code to a shopper, they use this API to request a code live. The Code API is documented here.
The Offer API (RESTful)
End Point
https://api.uniqodo.com/offers/API_KEY/FORMAT
Set the API key value
https://api.uniqodo.com/offers/6c702c6989223420f4ddde4e19da4016b2f9f54c/
|
Parameter |
Description |
Required |
Default |
|
API Key |
The API key assigned to the distributor. |
Yes |
N/A |
Set the data format value
https://api.uniqodo.com/offers/6c702c6989223420f4ddde4e19da4016b2f9f54c/json
|
Parameter |
Description |
Required |
Default |
|
Format |
The response data format. Choose from json, xml or csv |
No |
json |
Filter response to specific merchants
https://api.uniqodo.com/offers/6c702c6989223420f4ddde4e19da4016b2f9f54c/json?merchants=123,145,126
Parameter | Description | Required | Default |
Merchants | A comma separated list of merchant IDs can be supplied to the URL. This list will reduce the result set of offers to only the specified merchants. To use, add the 'merchants' query string parameter with comma separated merchant IDs as the value. | No | N/A |
Response
Item | Description | Example |
id | The unique identifier for each merchant offer | 451 |
merchant_id | The ID of the merchant running the offer | 1256 |
merchant_name | The name of the merchant running the offer | XYZ Electronics |
description | A short description of the offer for shoppers | 10% Off electronics through May 2016 |
status | The status of the offer. Can be either: “active” or “paused” | active |
terms | The terms describing the rules, criteria and eligibility of the offer | Paragraph Text |
code_remaining | The number of codes that are left to be claimed or redeemed for this offer | 27 |
code_volume_limit_type | The limit type for how the codes for the associated offer are limited by x can be claimed or x can be redeemed. | “claim” or “redemption” |
code_type | The type of code. Values can be: “unique”, “repeat” or “secure” | unique |
code_expiry | The number of units of time that the codes will be valid for. (Used with code_expiry_unit | 15 |
code_expiry_unit | The unit of time used with code_expiry that states the length of time a code is valid for after it is claimed/issued | minute |
start_date | The start date and time that the offer becomes active and valid for redemption | 2015-09-20T00:00:00+0100 |
end_date | The end date and time that the offer becomes inactive and is no longer valid for redemption | 2015-12-31T23:59:59+0000 |
last_updated | The date and time that the offer was last updated. | 2016-07-13T12:13:25+0100 |
redemption_per_code | The number of times that the a code can be repeatedly redeemed. | 5 |
Errors
|
Error Code |
Message |
Reason |
|
101 |
Invalid API key supplied |
The API key supplied in the request in not valid |
|
102 |
Quota limit exceeded |
Offer download limit for the API key supplied has been reached. Each distributor has a monthly limit currently at 90 requests for offer download. This does not affect code requests. |
|
400 |
The request could not be completed- check that parameters are correct |
One of the required parameters may be missing or the URL is badly formed |
|
406 |
The requested data format is currently not supported. Allowed types are JSON, XML & CSV only. |
Wrong data format in the request URL |
