CLcleeng

Fetch offer details

Changed on

Use /offers/:offerId endpoint to get basic offer details. <br><br> This endpoint returns details of offer localizations matching a particular country or location. The country or location is determined based on the customer IP address. <br><br> You can query using the offer short ID - without a country suffix (e.g. S123123123) to dynamically retrieve details of the offer localization matching the current country of the user. You can query using the offer long ID - with country suffix e.g. (S123123123_US) to retrieve details of the offer localization for a particular country. <br><br> If you want to fetch offer details for a specific customer use this endpoint. <br><br> **Note: <br> **Please note that this endpoint will not return taxes for the USA and Canada. Taxes will only be shown during the checkout process (they are returned in the order method: Create order or Get an order).

get/offers/{offerId}

Request

  • Base URL
    https://mediastoreapi-sandbox.cleeng.com
  • URL
    https://mediastoreapi-sandbox.cleeng.com/offers/{offerId}
  • Auth
    none required

Path parameters

offerIdstring required

Cleeng offer ID, e.g. S123123123_US or S123123123.

Query parameters

customerIPstring

Recommended. IP address of customer current location. Add this param to get offer details for a specific location (e.g. the price may vary depending on the country tax policy)

Response

200

Example response

{
  "responseData": {
    "offerId": "S567921766_NL",
    "offerPrice": 22.22,
    "offerCurrency": "EUR",
    "offerCurrencySymbol": "€",
    "offerCountry": "NL",
    "customerPriceInclTax": 22.58,
    "customerPriceExclTax": 18.36,
    "customerCurrency": "EUR",
    "customerCurrencySymbol": "€",
    "customerCountry": "PL",
    "offerUrl": "https://google.com.ua",
    "offerTitle": "Monthly subscription (recurring) to qadigger",
    "active": true,
    "createdAt": 1580116969,
    "updatedAt": 1580116969,
    "applicableTaxRate": 0.21,
    "averageRating": 4,
    "period": "month",
    "accessToTags": [
      "(all)"
    ]
  }
}

Changes

  • b4b65aa4f14cRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      api operation id get-an-offer removed and replaced with fetch-offer-details

    • info

      added the new optional query request parameter customerIP

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status