Docs
View as Markdown

klarna.product_compare

beta 2 credits needs a pack

Compare two Klarna products side by side.

GET /v1/klarna/product_compare

What you get#

A list of Klarna results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

Also known as: /klarna/product/compare on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
product_idstringyes(required)Product id as it appears on the product page URLmax 64 chars; must match [A-Za-z0-9_.\-]{1,64}; trimmed
product_id_2stringyes(required)Second product id to compare againstmax 64 chars; must match [A-Za-z0-9_.\-]{1,64}; trimmed

Request#

curl "https://api.onekey.dev/v1/klarna/product_compare?product_id=123456789&product_id_2=987654321" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Klarna response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "123456789",
        "name": "Sample Product",
        "url": "https://www.example-shop.com/p/123456789",
        "description": "Sample description.",
        "stats": {
          "rating": 4.6,
          "ratingCount": 128
        }
      },
      "media": {
        "thumbnailUrl": "https://images.example-shop.com/p/1.jpg"
      },
      "listing": {
        "price": 19.99,
        "currency": "USD",
        "brand": "Acme"
      },
      "ext": {
        "differences": "battery life"
      }
    },
    {
      "entity": {
        "id": "123456789",
        "name": "Sample Product",
        "url": "https://www.example-shop.com/p/123456789",
        "description": "Sample description.",
        "stats": {
          "rating": 4.6,
          "ratingCount": 128
        }
      },
      "media": {
        "thumbnailUrl": "https://images.example-shop.com/p/1.jpg"
      },
      "listing": {
        "price": 19.99,
        "currency": "USD",
        "brand": "Acme"
      },
      "ext": {
        "differences": "battery life"
      }
    }
  ],
  "metadata": {
    "platform": "klarna",
    "endpoint": "product_compare",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
identity.id-
titleentity.name-
urlentity.urlsafeUrl
descriptionentity.description-
imagemedia.thumbnailUrlsafeUrl
pricelisting.pricetoNumber
currencylisting.currency-
brandlisting.brand-
ratingentity.stats.ratingtoNumber
review_countentity.stats.ratingCounttoNumber
differencesext.differences-

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).