These docs are for v2.0. Click to read the latest docs for v2.1.

createMultiCurrencySingleOffer

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

📘

You can try that method by clicking here

Parameters

NameTypeDescription
publisherToken*stringYou can find your publisher token at api-keys page.
offerData*objectNo description
-price*floatOffer price (in publisher's currency), value between 0.14 and 99.99
-title*stringOffer title, up to 70 chars
-url*stringUrl to content
-descriptionstringAdditional offer description, up to 110 chars
-tagsarrayTags attached to offer. Read more.
localizedDataarray-
-country*string2-letter country code
-currency*stringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-price*floatvalue between 0.14 and 99.99
-title*stringOffer title, unique for the localization, up to 70 chars
-url*stringUrl to content
-descriptionstringOffer description, unique for the localization, up to 110 chars
-videoIdstringLink offer with unique video asset id
-contentExternalIdstringThis parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you.
-contentExternalDatastringIf you want to store a few extra elements related to the sale you can use this string to store additional data.
-geoRestrictionEnabledboolSet "true" to enable geo-restriction on this offer
-geoRestrictionTypestringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountriesarrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.

API Request/Response

Request

{
  "method":"createMultiCurrencySingleOffer",
  "params":{
    "publisherToken":"klj_nerb324sPLhmzLtp4mDmdc8slwNNyALt-1Xn2Hy0Icfay",
    "offerData":{
      "price":"10",
      "tags":[
      ]
    }, 
    "localizedData":[
     {
       "country":"US",
       "currency":"USD",
       "price":"11",
       "title":"Test offer for US customers"
      },
      {
        "country":"FR",
        "currency":"EUR",
        "price":"9"
      }
     ]
   },
   "jsonrpc":"2.0",
   "id":1
}

Response

{
  "result":{
    "multiCurrencyOfferId":"A898748181",
      "offers":[
        {
          "id":"A898748181_FR",
          "publisherEmail":"[email protected]",
          "url":"http:\/\/testoffer.com\/fr",
          "title":"Test offer for French customers",
          "description":"Test offer description",
          "currency":"EUR",
          "averageRating":4,
          "active":true,
          "createdAt":1384260092,
          "updatedAt":1384266187,
          "price":9,
          "applicableTaxRate":"0.21",
          "tags":[

          ],
          "videoId":"",
          "contentExternalId":"0",
          "contentExternalData":null
        },
        {
          "id":"A898748181_US",
          "publisherEmail":"[email protected]",
          "url":"http:\/\/www.testoffer.com",
          "title":"Test offer for US customers",
          "description":"Test offer description",
          "currency":"USD",
          "averageRating":4,
          "active":true,
          "createdAt":1384260091,
          "updatedAt":1384266188,
          "price":11,
          "applicableTaxRate":"0.21",
          "tags":[

          ],
          "videoId":"",
          "contentExternalId":"0",
          "contentExternalData":null
        }
      ]
  },
  "id":"1",
  "error":nul
  "jsonrpc":"2.0"
}