# Katalogsonderangebot abrufen

Ruft das angegebene Katalogsonderangebot ab.

Endpoint: GET /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt sowie in der Adressleiste des Browsers, wenn Sie im Kundenportal ein Projekt geöffnet haben. Die URL hat das folgende Format: https://publisher.xsolla.com//projects/.
    Example: 44056

  - `external_id` (integer, required)
    Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.
    Example: "coupon_44056_1"

## Response 200 fields (application/json):

  - `external_id` (string)
    Eindeutige Werbeaktions-ID. Die external_id darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

  - `promotion_periods` (array)
    Gültigkeitszeitraum der Werbeaktion. Wenn mehrere Zeiträume angegeben sind, sind sowohl date_from als auch date_until erforderlich.

  - `promotion_periods.date_from` (string, required)
    Startdatum für die angegebene Werbeaktion.
    Example: "2020-08-11T10:00:00+03:00"

  - `promotion_periods.date_until` (string,null)
    Enddatum für die angegebene Werbeaktion. Wenn null festgelegt ist, läuft die Werbeaktion unbefristet. Kann nur null sein, wenn ein einzelner Gültigkeitszeitraum angegeben ist.
    Example: "2020-08-11T20:00:00+03:00"

  - `name` (object)
    Name der Werbeaktion. Sollte Schlüssel-Wert-Paare enthalten,
wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.

  - `items` (array)
    Eine Liste der Artikel-SKU, die nach Inanspruchnahme des Katalogsonderangebots verfügbar sind.
    Example: ["booster_mega_1"]

  - `is_enabled` (boolean)

  - `redeem_total_limit` (integer,null)
    Begrenzt die Gesamtzahl der Gutscheine.

  - `redeem_user_limit` (integer,null)
    Begrenzt, wie oft ein einzelner Nutzer Gutscheine einlösen darf.

  - `redeem_code_limit` (integer,null)
    Anzahl der Einlösungen pro Code.

  - `total_limit_state` (object,null)
    Limits für jeden eindeutigen Gutscheincode.

  - `total_limit_state.available` (integer)
    Wie oft ein Gutschein noch eingelöst werden kann.
    Example: 3

  - `total_limit_state.reserved` (integer)
    Wie oft ein Gutschein reserviert wurde.
    Example: 3

  - `total_limit_state.used` (integer)
    Wie oft ein Gutschein eingelöst wurde.
    Example: 5

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"

## Response 404 fields (application/json):

  - `statusCode` (integer)
    Example: 404

  - `errorCode` (integer)
    Example: 4001

  - `errorMessage` (string)
    Example: "[0401-9802]: Coupon not found"

  - `transactionId` (string)
    Example: "x-x-x-x-transactionId-mock-x-x-x"