Preview a link's catalog

Shows what the link’s landing page offers now, with the landing page’s rules: active or deactivation-scheduled sets, both toggles on, inside the link’s restrictions, not depleted, and with a redeemable Price Acceptance; at most 200 sets in landing order. hiddenForPriceAcceptance lists sets left out only because of a missing Price Acceptance. Accepts no query parameters. See Redemption links.

Required permissions: view-consumer-redemption-links, view-consumer-catalog · API keys: allowed

GET /consumer/v1/redemption-links/{redemptionLinkId}/catalog

Preview a link's catalog

cURL

curl --request GET \
  --url https://api.voucher-staging.allride.io/consumer/v1/redemption-links/{redemptionLinkId}/catalog \
  --header 'Authorization: Bearer <token>'

200

default

{
  "data": {
    "resource": "link-catalog-preview",
    "redemptionLinkId": 8017,
    "truncated": false,
    "totalVoucherSets": 1,
    "hiddenForPriceAcceptance": [],
    "entries": [
      {
        "id": 2030,
        "resource": "consumer-catalog-entry",
        "providerPartnerId": 1030,
        "provider": {
          "id": 1030,
          "resource": "consumer-catalog-provider",
          "slug": "acme-scooters",
          "displayName": {
            "de": "Acme Scooters",
            "en": "Acme Scooters"
          },
          "logoUrl": "https://assets.voucher.allride.io/acme-scooters/3095.png",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
              "type": "application/json"
            }
          }
        },
        "voucherKind": "code",
        "availability": "active",
        "activeFrom": "2026-10-01T00:00:00Z",
        "deactivateAt": null,
        "revisionNo": 2,
        "revisionApprovedAt": "2026-09-28T09:40:11Z",
        "live": {
          "name": {
            "de": "5 € Fahrguthaben",
            "en": "€5 ride credit"
          },
          "summary": {
            "de": "Für alle E-Scooter",
            "en": "For all e-scooters"
          },
          "bullets": [
            {
              "de": "Einmal einlösbar",
              "en": "Single use"
            }
          ],
          "description": null,
          "howToRedeem": [
            {
              "de": "App öffnen und Code unter Wallet eingeben",
              "en": "Open the app and enter the code under Wallet"
            }
          ],
          "termsText": {
            "de": "Einmal pro Konto einlösbar.",
            "en": "Redeemable once per account."
          },
          "valueLabel": {
            "de": "5 € Rabatt",
            "en": "€5 off"
          },
          "faceValue": {
            "value": 500,
            "label": "€5.00"
          },
          "categoryId": 7017,
          "linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
          "allowedLinkHosts": [
            "acme-scooters.example.com"
          ],
          "allowedLinkSchemes": [],
          "brandingOverride": null,
          "countries": [
            "DE"
          ],
          "extensions": null,
          "metadata": null
        },
        "brandingOverrideAssetUrls": null,
        "stockStatus": "available",
        "providerToggle": true,
        "voucherSetToggle": true,
        "position": 1,
        "featured": true,
        "effectiveCategoryId": 7017,
        "priceAcceptance": {
          "status": "accepted",
          "nextChangeAt": null
        },
        "setting": {
          "enabled": true,
          "position": null,
          "featured": false,
          "categoryOverrideId": null,
          "entityLimit": {
            "max": 1,
            "period": "calendar-month"
          },
          "settings": null,
          "externalRef": "3",
          "updatedAt": "2026-10-20T10:02:00Z"
        },
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
            "type": "application/json"
          },
          "provider": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
            "type": "application/json"
          }
        }
      }
    ],
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/redemption-links/8017/catalog",
        "type": "application/json"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Path Parameters

redemptionLinkId · integer<uint64> · required

Id of the Redemption Link. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Response

200

application/json

OK

Single-object envelope around a LinkCatalogPreview.

data · object · required

What the link's landing page shows now (same rules as the landing page).

Show child attributes