Get tulo loyalty offers
/me/tulo_loyalty_offers
Target audience: Developers
Get Tulo loyalty offers
Introduction
This endpoint returns Loyalty Offers from Tulo Loyalty Clubs within your organisation. Offers are filtered on whether they are active, and whether the current account has any loyalty products that gives access to an offer. Current account is the identity associated with the access-token being used. Please note that your organisation must have an active Loyalty Club integration to be able to use this endpoint. Please contact support if you have any questions about this.
URI
Environment |
URI |
Stage |
https://payway-api.stage.adeprimo.se/external/api/v1/me/tulo_loyalty_offers |
Production |
https://backend.worldoftulo.com/external/api/v1/me/tulo_loyalty_offers |
Requirements
Identity |
Scope |
Yes |
/external/me/r |
Curl Example
curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v1/me/tulo_loyalty_offers \
--header 'accept: application/json' \
--header 'authorization: Bearer <access_token_with_identity>'
Response
Example response
HTTP 200
{
"items": [
{
"url": "lojalitetskort.mydomain.se/?pageid=&oid=7582",
"name": "Name of offers",
"subject": "Subject of offer",
"text": "Some description of the offer, possible with embedded html-tags.",
"validFrom": "2017-10-10T22:00:00Z",
"validTo": "2017-12-10T22:59:59Z",
"imageurl": "http://tulo.worldoftulo.com/customercard_files/asdfqwerty.jpg",
"imageurls": [
"http://tulo.worldoftulo.com/customercard_files/asdfqwerty.jpg"
],
"zipcode": "",
"city": "",
"geocodingaddress": "",
"geocodinglongitude": "",
"geocodinglatitude": "",
"ispremiumoffer": false,
"interests": [
"loyalty_product_code_1",
"loyalty_product_code_2"
]
}
]
}
Errors
Example error response
HTTP 400 Bad Request
{
"code": "invalid_parameter",
"field": "account_id",
"message": "Parameter must match format (/^[a-f\d]{24}$/)"
}
HTTP 400 Bad Request
Name |
Type |
Description |
configuration_error |
Object |
The Tulo Loyalty integration is not enabled for this account |
unknown_parameter |
Object |
One or more parameters was not recognized |
HTTP 404 Not Found
Name |
Type |
Description |
not_found |
Object |
The account could not be found |
HTTP 500 Internal Server Error
Name |
Type |
Description |
internal_server_error |
Object |
Something unexpected happened server side |