# Order bumps

`GET https://api.tentary.com/v1/order-bumps`

Source: https://tentary.com/de/help/api/list-order-bumps/
Area: Order Bumps
MCP tool: `list_order_bumps`. Reads only. Changes nothing in the account.

---

The order bumps, newest first. An order bump is an extra offer that buyers add with one checkbox at the checkout. For each: name, status, the offered product (with its status), price and product price, title, description, checkbox text, the products whose checkout shows it, sales and revenue, and the admin link.

- `active`: buyers see it at the checkout.
- `inactive`: hidden at every checkout. It keeps its settings and sales.

Without `status`, the list has active and inactive order bumps. Deleted order bumps are not listed.

- `product_ids` `null` means the checkouts of all products.
- `sales` and `revenue` count the orders with this order bump that are paid or in payment, like the order bump editor in the app. They are only in this list.

The fields have the same names and formats as in [`POST /v1/order-bumps`](https://tentary.com/de/help/api/create-order-bump/) and [`PATCH /v1/order-bumps/{order_bump_id}`](https://tentary.com/de/help/api/update-order-bump/).

## Authorization

`Authorization: Bearer <API key>`

A personal API key (tnt_...). Create it in the Tentary app on the page AI & API.

## Query parameters

- `status` (string, query): Only order bumps with this status. Allowed values: `active`, `inactive`.
- `cursor` (string, query): 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, query): Items per page, default 25. Limits: min 1, max 50.

## Response

- `order_bumps` (array of object): Newest first.
  - `id` (integer): The ID.
  - `name` (string): Name in the Tentary app. Buyers do not see it.
  - `status` (string): active = buyers see it at the checkout. inactive = hidden at every checkout, kept with its settings and sales. Allowed values: `active`, `inactive`.
  - `product` (object): The offered product.
    - `id` (integer): The ID.
    - `name` (string, can be null): The name.
    - `status` (string): The status. Allowed values: `live`, `draft`, `archived`, `deleted`.
  - `price` (string): Decimal string, like "19.90". What buyers pay for the order bump.
  - `product_price` (string): Decimal string, like "19.90". The price of the product. Shown crossed out when price is lower.
  - `currency` (string): Currency code, like EUR.
  - `title` (string, can be null): null = the product title.
  - `description_html` (string): Short text about the offer, HTML.
  - `checkbox_text` (string, can be null): null = "Yes, add to my order".
  - `hide_product_image` (boolean)
  - `product_ids` (array of integer, can be null): The products whose checkout shows it. null = all products.
  - `admin_url` (string<uri>): The page in the Tentary app.
  - `sales` (integer): Orders with this order bump that are paid or in payment (like the editor).
  - `revenue` (string): Decimal string, like "19.90". What buyers paid for it in these orders.
- `next_cursor` (string, can be null): 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.
  - `order_bumps` (string<uri>): Page in the Tentary app.
  - `new_order_bump` (string<uri>): Page in the Tentary app.

## Example request

```bash
curl "https://api.tentary.com/v1/order-bumps" \
  -H "Authorization: Bearer $TENTARY_API_KEY"
```

## Example response

```json
{
  "order_bumps": [
    {
      "id": 1,
      "name": "E-book with the course",
      "status": "active",
      "product": {
        "id": 101,
        "name": "Yoga Basics E-Book",
        "status": "live"
      },
      "price": "9.00",
      "product_price": "19.00",
      "currency": "EUR",
      "title": null,
      "description_html": "<p>The 20 most important poses to look up after each lesson.</p>",
      "checkbox_text": "Yes, add the e-book for 9 EUR",
      "hide_product_image": false,
      "product_ids": [
        102
      ],
      "admin_url": "https://app.tentary.com/orderbumps/edit/1",
      "sales": 0,
      "revenue": "0.00"
    }
  ],
  "next_cursor": null,
  "links": {
    "order_bumps": "https://app.tentary.com/orderbumps",
    "new_order_bump": "https://app.tentary.com/orderbumps/new"
  }
}
```