createMultiCurrencyRentalOffer()


Create different offers for different countries and currencies using localizedData array.

Parameters:

Name Type Description
publisherToken string You can find your publisher token at api-keys page.
offerData object No description
-pricefloatOffer price (in publisher's currency), value between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-periodintegerAmount of time after which purchase will expire (in hours)
-urlstringUrl to content
-description stringAdditional offer description, up to 110 chars
-associateEmail stringSet your associate email
-tags arrayTags attached to offer. Read more.
-countrystring2-letter country code
-currencystringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-pricefloatvalue between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-url stringUrl to content
-description stringAdditional offer description, up to 110 chars
-videoId stringLink offer with unique video asset id
-contentExternalId stringThis parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you.
-contentExternalData stringIf you want to store a few extra elements related to the sale you can use this string to store additional data.
-geoRestrictionEnabled boolSet "true" to enable geo-restriction on this offer
-geoRestrictionType stringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountries arrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.
localizedData array No description
-pricefloatOffer price (in publisher's currency), value between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-periodintegerAmount of time after which purchase will expire (in hours)
-urlstringUrl to content
-description stringAdditional offer description, up to 110 chars
-associateEmail stringSet your associate email
-tags arrayTags attached to offer. Read more.
-countrystring2-letter country code
-currencystringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-pricefloatvalue between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-url stringUrl to content
-description stringAdditional offer description, up to 110 chars
-videoId stringLink offer with unique video asset id
-contentExternalId stringThis parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you.
-contentExternalData stringIf you want to store a few extra elements related to the sale you can use this string to store additional data.
-geoRestrictionEnabled boolSet "true" to enable geo-restriction on this offer
-geoRestrictionType stringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountries arrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.

- required parameter


Request:

[
    {
        "method": "createMultiCurrencyRentalOffer",
        "params": {
            "publisherToken": "klj_nerb324sPLhmzLtp4mDmdc8slwNNyAdt-1Xn2Hy0Icfay",
            "offerData": {
                "price": "10",
                "title": "Tasty and healthy food",
                "period": "24",
                "url": "http:\/\/www.testoffer.com",
                "description": "Test offer description",
                "associateEmail": "associate@email.com",
                "tags": []
            },
            "localizedData": [
                {
                    "country": "US",
                    "currency": "USD",
                    "price": "10",
                    "title": "Test offer for US customers"
                },
                {
                    "country": "FR",
                    "currency": "EUR",
                    "price": "8",
                    "title": "Test offer for French customers",
                    "url": "http:\/\/testoffer.com\/fr"
                }
            ]
        },
        "jsonrpc": "2.0",
        "id": 1
    }
]

Response:

[
    {
        "result": {
            "multiCurrencyOfferId": "R841924054",
            "offers": [
                {
                    "id": "R841924054_US",
                    "publisherEmail": "associate@email.com",
                    "url": "http:\/\/www.testoffer.com",
                    "title": "Test offer for US customers",
                    "description": "Test offer description",
                    "currency": "USD",
                    "averageRating": 4,
                    "active": true,
                    "createdAt": 1384260473,
                    "updatedAt": 1384260473,
                    "price": 10,
                    "applicableTaxRate": "0.21",
                    "tags": [],
                    "period": "24",
                    "videoId": "",
                    "contentExternalId": 0,
                    "contentExternalData": null
                },
                {
                    "id": "R841924054_FR",
                    "publisherEmail": "associate@email.com",
                    "url": "http:\/\/testoffer.com\/fr",
                    "title": "Test offer for French customers",
                    "description": "Test offer description",
                    "currency": "EUR",
                    "averageRating": 4,
                    "active": true,
                    "createdAt": 1384260473,
                    "updatedAt": 1384260473,
                    "price": 8,
                    "applicableTaxRate": "0.21",
                    "tags": [],
                    "period": "24",
                    "videoId": "",
                    "contentExternalId": 0,
                    "contentExternalData": null
                }
            ]
        },
        "id": "1",
        "error": null,
        "jsonrpc": "2.0"
    }
]

Remember! you can always check it by yourself using API Console - createMultiCurrencyRentalOffer()

Back to Rental Offers


We use cookies to ensure that we provide you the best service and website experience. Read our Cookie policy for more details.