Deutsch DE
API-Referenz
API-Referenz

Rabattcodes

Coupons

GET / v1 / coupons

The coupons (discount codes), newest first: code, status, state, percent or amount, uses and use limit, start and end day, the products they apply to (with their status live, draft, archived or deleted), and admin links.

status is what you set: active or archived. Without status, the list has active coupons only. Archived coupons are deleted coupons.

state is the result for buyers, and read only:

  • valid: buyers can use the code now.
  • scheduled: the start is in the future.
  • expired: the end is in the past.
  • used_up: the use limit is reached.
  • archived: deleted.
  • no_products: the coupon applies to no live product. The checkout sells only live products.
  • reserved: open checkouts of the last hour hold the remaining uses. They become free again if the buyers do not pay.

The fields have the same names and formats as in POST /v1/coupons and PATCH /v1/coupons/{coupon_id}.

Liest nur MCP-Werkzeug list_coupons

Autorisierung

  • Authorization string Header erforderlich

    Bearer tnt_… · A personal API key (tnt_...). Create it in the Tentary app on the page AI & API. Einführung

Query-Parameter

  • status string

    active (default) or archived.

    Mögliche Werte: activearchived

  • cursor string

    next_cursor of the previous page. Send the same filters and limit again: the cursor does not keep them. Leave out for the first page.

  • limit integer

    Items per page, default 25.

    min. 1 max. 50

Antwort

Felder der Antwort mit Status 200. Fehler haben immer dasselbe Format, siehe Fehler.

  • coupons array of object

    Newest first.

    16 Felder anzeigen Felder ausblenden
    • id integer

      The ID.

    • code string

      The code buyers type.

    • status string

      What the seller set. archived = deleted.

      Mögliche Werte: activearchived

    • state string

      The result for buyers: valid = buyers can use the code now.

      Mögliche Werte: validscheduledexpiredused_upreservedarchivedno_products

    • percent integer kann null sein

      Discount in percent, or null for a fixed amount.

    • amount string kann null sein

      Decimal string, like "19.90". Fixed discount, or null for a percent discount.

    • currency string

      Currency code, like EUR.

    • used integer

      How often the code was used.

    • max_uses integer kann null sein

      null = no limit.

    • reserved_in_open_checkouts integer

      Uses held by open checkouts of the last hour.

    • starts_on string<date> kann null sein

      Like 2026-01-31. First day the code works.

    • ends_on string<date> kann null sein

      Like 2026-01-31. The code stops at the start of this day.

    • product_ids array of integer kann null sein

      null = all products. [] = no product.

    • products array of object

      The products of product_ids (the first 200).

      3 Felder anzeigen Felder ausblenden
      • id integer

        The ID.

      • name string kann null sein

        The name.

      • status string

        The status.

        Mögliche Werte: livedraftarchiveddeleted

    • created_at string<date-time> kann null sein

      UTC, like 2026-01-31T14:05:00Z.

    • admin_url string<uri>

      The page in the Tentary app.

  • next_cursor string kann null sein

    Send it as cursor for the next page, with the same filters and limit. null = this is the last page.

  • links object

    Pages in the Tentary app or on tentary.com.

    2 Felder anzeigen Felder ausblenden
    • coupons string<uri>

      Page in the Tentary app.

    • new_coupon string<uri>

      Page in the Tentary app.

Tippe, um zu suchen.