API Reference · Details

OfferInfo API

Read current public Offer details by canonical offer_id or aonlink using a Live API Key, with the same business information as Query and no new distribution instance.

GET/v1/offers/infoBearer required

Read Offer details

Curated overlay

Headers

Fields

1·1 required

Showing the complete documented schema.

Authorizationstring

required

Bearer followed by your application-owned Live API Key. Test Keys are not supported.

example: Bearer <LIVE_API_KEY>

Query Parameters

At least one parameter is required. When both are supplied, they must identify the same Offer.

Fields

2·0 required/2 conditional

Showing the complete documented schema.

offer_idstring

required when offerurl is absent

Canonical Offer UUID returned by Query. An upstream Offer ID or bare offer_instance_id is not a canonical Offer ID.

example: 11111111-1111-4111-8111-111111111111format: uuid

offerurlstring

required when offer_id is absent

Complete existing aonlink, URL-encoded as one query parameter. Supports root short codes, root historical instance UUIDs and /static/st_… links.

example: https://aon.link/Ab12Cd34?subid=demo#detailsformat: uri

Request Examples

Read by offer_id

curl

curl --get 'https://api.aon.pro/v1/offers/info' \
  --header 'Authorization: Bearer <LIVE_API_KEY>' \
  --data-urlencode 'offer_id=11111111-1111-4111-8111-111111111111'

Read by aonlink

curl

curl --get 'https://api.aon.pro/v1/offers/info' \
  --header 'Authorization: Bearer <LIVE_API_KEY>' \
  --data-urlencode 'offerurl=https://aon.link/Ab12Cd34?subid=demo#details'

HTTP 200 uses {code, message, data, extra}; data is the single Offer object, not an offers array or data.offer wrapper. The Offer document version is 3.0, matching Query v1.0's public business fields with the explicit instance/action differences below.

Fields

12·9 required/1 conditional/2 optional

Showing the complete documented schema.

codestring

required

SUCCESS on HTTP 200; otherwise the error code.

example: SUCCESS

messagestring

required

Empty on success; a readable explanation on failure.

object

required

One public Offer on success; an empty object on failure.

8 nested fields

Required or conditional

offer_idstring

required

Stable canonical Offer identity.

format: uuid

versionstring

required

Offer document version, not the HTTP route version.

Allowed values3.0

offer_infoobject

required

Query public Offer information, including available commercial and details profile data. The same Query field semantics and optionality apply.

entityobject

required

Public entity information using Query's entity mapping.

goalsarray

required

Public goals using Query's CPA/CPS pricing semantics; CPS pricing.rate is a percentage string.

actionobject

required when offerurl is provided

Query public action metadata; payload.url exactly preserves the submitted aonlink. Omitted for ID-only reads.

Optional

content_languagestring

optional

Actual known language of the selected content; omitted when unknown.

materialarray

optional

Available public creative assets using Query's material validation and limits.

extraobject

required

Empty object for this route.

Response Examples

Success by offer_id

JSON

{
  "code": "SUCCESS",
  "message": "",
  "data": {
    "offer_id": "11111111-1111-4111-8111-111111111111",
    "version": "3.0",
    "content_language": "en",
    "offer_info": {
      "title": "Example offer",
      "category": {
        "id": "others"
      },
      "description": "Example offer details"
    },
    "entity": {
      "id": "example-merchant",
      "name": "Example Merchant",
      "type": "merchant"
    },
    "goals": [
      {
        "event": "purchase",
        "pricing": {
          "model": "cpa",
          "amount": "1.00",
          "currency": "USD"
        }
      }
    ]
  },
  "extra": {}
}

Success by aonlink

JSON

{
  "code": "SUCCESS",
  "message": "",
  "data": {
    "offer_id": "11111111-1111-4111-8111-111111111111",
    "version": "3.0",
    "content_language": "en",
    "offer_info": {
      "title": "Example offer",
      "category": {
        "id": "others"
      },
      "description": "Example offer details"
    },
    "entity": {
      "id": "example-merchant",
      "name": "Example Merchant",
      "type": "merchant"
    },
    "goals": [
      {
        "event": "purchase",
        "pricing": {
          "model": "cpa",
          "amount": "1.00",
          "currency": "USD"
        }
      }
    ],
    "action": {
      "type": "open_url",
      "name": "View offer",
      "consumer_action": "buy",
      "payload": {
        "url": "https://aon.link/Ab12Cd34?subid=demo#details"
      }
    }
  },
  "extra": {}
}

Errors and failure modes

Error Responses

Contract note: 409 are HTTP status values returned by the response status, not fields in the JSON response body. The response body remains the envelope { code, message, data, extra }.

HTTP 409: conflicting identities

body.code = OFFER_INFO_IDENTITY_CONFLICT

Response body

JSON

{
  "code": "OFFER_INFO_IDENTITY_CONFLICT",
  "message": "offer_id and offerurl resolve to different offers",
  "data": {},
  "extra": {}
}

{
  "code": "OFFER_INFO_IDENTITY_CONFLICT",
  "message": "offer_id and offerurl resolve to different offers",
  "data": {},
  "extra": {}
}

Behavior, compatibility, and source notes

Read one current public Offer by canonical offer_id or an existing aonlink, using an application-owned Live API Key.

Send Authorization: Bearer <LIVE_API_KEY> from your server. Live and Live Limited applications can call this route; paused or suspended applications cannot. Offer Query and MCP search continue to use placement identity without a new API Key requirement.
Provide offer_id, offerurl, or both. Both must resolve to the same canonical Offer; otherwise the response is 409 OFFER_INFO_IDENTITY_CONFLICT. A missing link mapping returns 404. Empty or malformed input returns 400.
offerurl is a complete aonlink, not a merchant destination URL. Supported paths are an eight-character alphanumeric root short code, a historical offer_instance_id UUID at the root, or /static/st_… . Use the aonlink origin configured for the API environment. URL-encode the entire parameter, including its query and fragment, as in --data-urlencode below.
The URL query and fragment do not change Offer identity. The response preserves the exact submitted aonlink in action.payload.url, including its existing attribution. A link from another application may locate a public Offer; ownership, trace, placement and user context are not returned or rebound.
This reads stored local and remote data without calling Query, following redirects, or contacting suppliers. It creates no offer instance, impression, click or link binding, and consumes no serving quota. Catalog membership and placement selection are not required.
Local content uses the stored original snapshot, without intent localization. Remote content selects an active English snapshot first, otherwise the most recently updated active snapshot, with a stable tie-break. content_language reports only the selected content's known language; unknown language is omitted. Language selection, translation and historical versions are not supported.
Only current public non-test content is returned: active, undeleted and non-delisted local Offers, or active remote snapshots. Missing mappings or snapshots and withdrawn content return 404. Temporary serving unavailability or an expired quote does not by itself hide details. Stored content may be stale and is not a new serving or price guarantee.
Business fields use the Query v1.0 public Offer projection for the selected stored data, including commercial/details profiles, entity, material and goals. CPA/CPS retain Query units; CPS rate is a percentage string. Optional fields are omitted when absent. Internal credentials, settlement contracts and recommendation context are not exposed.
offer_instance_id is always omitted, never null or a synthetic UUID. ID-only reads omit action; URL reads retain public action metadata and use the submitted aonlink. A malformed stored snapshot returns 503 instead of an incomplete success object.

Implementation checklist · 4 items

Create a Live API Key in Developer Portal under your application's API & Webhooks → API Keys. The application must be Live or Live Limited.
Supply canonical offer_id, a complete URL-encoded offerurl (aonlink), or both identifying the same Offer.
Treat the response as stored public content, not a fresh supplier quote or a guarantee that the Offer can currently be served.
Preserve the existing action URL when provided. offer_instance_id is never returned; ID-only reads omit action.

Errors & Rate Limits

Shared HTTP status, body envelope, and retry guidance.

OfferInfo API

Operations

Related links