Skip to content

/tulo_loyalty_offers

/accounts/tulo_loyalty_offers

Target audience: Developers

1
Release version: 3.9.1

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 Sanjin Coralic if you have any questions about this.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/accounts/tulo_loyalty_offers
Production https://backend.worldoftulo.com/external/api/v1/accounts/tulo_loyalty_offers

Required scope

1
/external/account/r

Parameters

Name Type Description
account_id String The id of the account.

Curl Example

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/account/tulo_loyalty_offers?account_id=1234567890 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token_with_identity>'

Response

Example response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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

1
2
3
4
5
HTTP 400 Bad Request
{
    "code": "unknown_parameter",
    "message": "No Tulo Loyalty Offers Integration enabled for Organisation"
}

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